Azure.ResourceManager.Cdn.Models 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 |
|---|---|
| ArmCdnModelFactory |
A factory class for creating instances of the models for mocking. |
| 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. |
| CanMigrateContent |
Request body for CanMigrate operation. |
| CanMigrateResult |
Result for canMigrate operation. |
| CdnCertificateSource |
Defines the parameters for using CDN managed certificate for securing custom domain. |
| CdnCustomDomainCreateOrUpdateContent |
The customDomain JSON object required for custom domain creation or update. |
| CdnDeploymentStages |
The preview and production deployment status of the deployment version under the profile. |
| CdnDeploymentVersionChange |
Deployment change under the profile Please note this is the abstract base class. The derived classes available for instantiation are: CdnDeploymentVersionRouteChange, CdnDeploymentVersionFrontDoorOriginGroupChange, CdnDeploymentVersionFrontDoorOriginChange, CdnDeploymentVersionRuleSetChange, CdnDeploymentVersionRuleChange, and CdnDeploymentVersionSecurityPolicyChange. |
| CdnDeploymentVersionFrontDoorOriginChange |
Deployment change of the origin group under the profile. |
| CdnDeploymentVersionFrontDoorOriginGroupChange |
Deployment change of the origin group under the profile. |
| CdnDeploymentVersionPatch |
Contains deployment version for creation or update. |
| CdnDeploymentVersionRouteChange |
Deployment change of the route under the profile. |
| CdnDeploymentVersionRuleChange |
Deployment change of the rule under the profile. |
| CdnDeploymentVersionRuleSetChange |
Deployment change of the rule set under the profile. |
| CdnDeploymentVersionSecurityPolicyChange |
Deployment change of the security policy under the profile. |
| CdnEdgeAction |
Defines the edge action for the delivery rule. |
| CdnEndpointPatch |
Properties required to create or update an endpoint. |
| CdnKeyGroupPatch |
The JSON object containing properties of key group to create or update. |
| CdnManagedHttpsContent |
Defines the certificate source parameters using CDN managed certificate for enabling SSL. |
| CdnMigrationToAfdContent |
Request body for Migrate operation. |
| CdnNameAvailabilityContent |
Input of CheckNameAvailability API. |
| CdnNameAvailabilityResult |
Output of check name availability API. |
| CdnOriginGroupPatch |
Origin group properties needed for origin group creation or update. |
| CdnOriginPatch |
Origin properties needed for origin update. |
| CdnProfileAgentPatch |
Properties required to update a profile agent association. |
| CdnResourceReference |
Reference to another resource. |
| CdnRouteProperties |
The JSON object that contains the properties of the Routes to create. |
| CdnRoutingRuleLink |
Defines the Resource ID for a Routing Rule. |
| CdnRuleProperties |
The JSON object that contains the properties of the Rules to create. |
| CdnRuleSetProperties |
The JSON object that contains the properties of the Rule Set to create. |
| CdnSecretProperties |
The JSON object that contains the properties of the Secret to create. |
| CdnSecurityPolicyLink |
Defines the Resource ID for a Security Policy. |
| CdnSecurityPolicyProperties |
The json object that contains properties required to create a security policy. |
| CdnSku |
Standard_Verizon = The SKU name for a Standard Verizon CDN profile. Premium_Verizon = The SKU name for a Premium Verizon CDN profile. Custom_Verizon = The SKU name for a Custom Verizon CDN profile. Standard_Akamai = The SKU name for an Akamai CDN profile. Standard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model. Standard_Microsoft = The SKU name for a Standard Microsoft CDN profile. Standard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile. Premium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile. Standard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model. Standard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model. StandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model. StandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model. StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model. |
| CdnUsage |
Output of check resource usage API. |
| CdnWebAgentKnowledgeSourcePatch |
Properties required to update a knowledge source. |
| CdnWebAgentPatch |
Properties required to update a web agent. |
| CdnWebAgentPath |
Defines a path configuration for a web agent. |
| CdnWebApplicationFirewallPolicyPatch |
Properties required to update a CdnWebApplicationFirewallPolicy. |
| 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. |
| CidrIPAddress |
CIDR Ip address. |
| ClientCertificateRequiredAndOriginValidatesAdvancedSettings |
Advanced settings for MtlsScenarioType enum value: ClientCertificateRequiredAndOriginValidates. |
| ClientCertificateRequiredAndValidatedAdvancedSettings |
Advanced settings for MtlsScenarioType enum value: ClientCertificateRequiredAndValidated. |
| ClientCertificateValidatedIfPresentedAdvancedSettings |
Advanced settings for MtlsScenarioType enum value: ClientCertificateValidatedIfPresented. |
| ClientPortMatchCondition |
Defines the parameters for ClientPort match conditions. |
| CompareDeploymentVersionsContent |
compare deployment versions request parameter. |
| CompareDeploymentVersionsResult |
compare deployment versions response. |
| CompleteMtlsPassthroughToOriginAdvancedSettings |
Advanced settings for MtlsScenarioType enum value: CompleteMtlsPassthroughToOrigin. |
| Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems |
The Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems. |
| Components1Gs0LlpSchemasMetricsresponsePropertiesSeriesItemsPropertiesDataItems |
The Components1Gs0LlpSchemasMetricsresponsePropertiesSeriesItemsPropertiesDataItems. |
| ComponentsKpo1PjSchemasWafrankingsresponsePropertiesDataItemsPropertiesMetricsItems |
The ComponentsKpo1PjSchemasWafrankingsresponsePropertiesDataItemsPropertiesMetricsItems. |
| ContinentsResponse |
Continents Response. |
| ContinentsResponseContinentsItem |
The ContinentsResponseContinentsItem. |
| ContinentsResponseCountryOrRegionsItem |
The ContinentsResponseCountryOrRegionsItem. |
| 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. |
| CustomRuleFrontDoor |
Defines contents of a web application rule. |
| 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: FrontDoorUrlSigningAction, UriRedirectAction, UriSigningAction, OriginGroupOverrideAction, CdnEdgeAction, 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, DeliveryRuleEdgeActionProperties, 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. |
| DeliveryRuleEdgeActionProperties |
Defines the parameters for the edge action. |
| 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. |
| EdgeNode |
Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users. |
| EndpointDeliveryPolicy |
A policy that specifies the delivery rules to be used for an endpoint. |
| EndpointNameAvailabilityContent |
Input of CheckNameAvailability API. |
| EndpointNameAvailabilityResult |
Output of check name availability API. |
| FrontDoorActivatedResourceInfo |
Reference to another resource along with its state. |
| 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. |
| FrontDoorCustomDomainMtlsSettings |
Contains the properties to configure mutual TLS for a custom domain with FQDN. Mutual TLS cannot be configured for custom domains with wildcard host names. Please note this is the abstract base class. The derived classes available for instantiation are: ClientCertificateRequiredAndValidatedAdvancedSettings, ClientCertificateRequiredAndOriginValidatesAdvancedSettings, ClientCertificateValidatedIfPresentedAdvancedSettings, and CompleteMtlsPassthroughToOriginAdvancedSettings. |
| FrontDoorCustomDomainPatch |
The domain JSON object required for domain creation or update. |
| FrontDoorEndpointPatch |
Properties required to create or update an endpoint. |
| FrontDoorOriginCapacitySettings |
Origin capacity settings for an origin. |
| FrontDoorOriginGroupPatch |
AFDOrigin group properties needed for origin group creation or update. |
| FrontDoorOriginGroupProperties |
The JSON object that contains the properties of the origin group. |
| FrontDoorOriginPatch |
AFDOrigin properties needed for origin update. |
| FrontDoorOriginProperties |
The JSON object that contains the properties of the origin. |
| FrontDoorPurgeContent |
Parameters required for content purge. |
| FrontDoorRouteCacheConfiguration |
Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object. |
| FrontDoorRoutePatch |
The domain JSON object required for domain creation or update. |
| FrontDoorRulePatch |
The domain JSON object required for domain creation or update. |
| FrontDoorSecretMtlsCertificateChain |
Server-side certificate used for mTLS validation. |
| 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, AzureFirstPartyManagedCertificateProperties, and FrontDoorSecretMtlsCertificateChain. |
| FrontDoorSecurityPolicyPatch |
The JSON object containing security policy update parameters. |
| FrontDoorStateProperties |
The tracking states for afd resources. |
| FrontDoorUrlSigningAction |
Defines the url signing action for the delivery rule. |
| FrontDoorUrlSigningActionContent |
Defines the parameters for the Url Signing action. |
| FrontDoorUsage |
Describes resource usage. |
| FrontDoorUsageResourceName |
The usage names. |
| FrontDoorWafLogScrubbingRule |
Defines the contents of the log scrubbing rules. |
| FrontDoorWebApplicationFirewallPolicyProperties |
Defines web application firewall policy. |
| FrontendEndpointLink |
Defines the Resource ID for a Frontend Endpoint. |
| 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. |
| HostNameAvailabilityContent |
Input of CheckHostNameAvailability API. |
| 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. |
| IPAddressGroup |
CDN Ip address group. |
| 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. |
| LoadContent |
Parameters required for content load. |
| ManagedCertificateProperties |
Managed Certificate used for https. |
| ManagedRuleDefinition |
Describes a managed rule definition. |
| ManagedRuleExclusion |
Exclude variables from managed rule evaluation. |
| ManagedRuleGroupDefinition |
Describes a managed rule group. |
| ManagedRuleGroupOverrideFrontDoor |
Defines a managed rule group override setting. |
| ManagedRuleGroupOverrideSetting |
Defines a managed rule group override setting. |
| ManagedRuleOverrideFrontDoor |
Defines a managed rule group override setting. |
| ManagedRuleOverrideSetting |
Defines a managed rule group override setting. |
| ManagedRuleSetDefinition |
Describes a managed rule set definition. |
| ManagedRuleSetFrontDoor |
Defines a managed rule set. |
| MatchConditionFrontDoor |
Define a match condition. |
| MetricsResponse |
Metrics Response. |
| MetricsResponseSeriesItem |
The MetricsResponseSeriesItem. |
| MetricsResponseSeriesPropertiesItemsItem |
The MetricsResponseSeriesPropertiesItemsItem. |
| MigrateResult |
Result for migrate operation. |
| MigrationContent |
Request body for Migrate operation. |
| MigrationEndpointMapping |
CDN Endpoint Mapping. |
| MigrationErrorType |
Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message. |
| MigrationWebApplicationFirewallMapping |
Web Application Firewall Mapping. |
| 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. |
| PolicySettingsFrontDoor |
Defines top-level WebApplicationFirewallPolicy configuration settings. |
| PostArgsMatchCondition |
Defines the parameters for PostArgs match conditions. |
| ProfileChangeSkuWafMapping |
Parameters required for profile upgrade. |
| ProfileLogScrubbing |
Defines rules that scrub sensitive fields in the Azure Front Door profile logs. |
| ProfilePatch |
Properties required to update a profile. |
| ProfileResourceGetLogAnalyticsMetricsOptions |
The ProfileResourceGetLogAnalyticsMetricsOptions. |
| ProfileResourceGetLogAnalyticsRankingsOptions |
The ProfileResourceGetLogAnalyticsRankingsOptions. |
| ProfileResourceGetWafLogAnalyticsMetricsOptions |
The ProfileResourceGetWafLogAnalyticsMetricsOptions. |
| ProfileResourceGetWafLogAnalyticsRankingsOptions |
The ProfileResourceGetWafLogAnalyticsRankingsOptions. |
| ProfileScrubbingRules |
Defines the contents of the log scrubbing rules. |
| ProfileUpgradeContent |
Parameters required for profile upgrade. |
| PurgeContent |
Parameters required for content purge. |
| QueryStringMatchCondition |
Defines the parameters for QueryString match conditions. |
| RankingsResponse |
Rankings Response. |
| RankingsResponseTablesItem |
The RankingsResponseTablesItem. |
| RankingsResponseTablesPropertiesItemsItem |
The RankingsResponseTablesPropertiesItemsItem. |
| RankingsResponseTablesPropertiesItemsMetricsItem |
The RankingsResponseTablesPropertiesItemsMetricsItem. |
| RateLimitGroupByVariable |
Describes the variables available to group the rate limit requests. |
| 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. |
| ResourcesResponse |
Resources Response. |
| ResourcesResponseCustomDomainsItem |
The ResourcesResponseCustomDomainsItem. |
| ResourcesResponseEndpointsItem |
The ResourcesResponseEndpointsItem. |
| ResourcesResponseEndpointsPropertiesItemsItem |
The ResourcesResponseEndpointsPropertiesItemsItem. |
| 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: SecurityPolicyWebApplicationFirewallParametersWithEmbeddedWafPolicy and SecurityPolicyWebApplicationFirewall. |
| SecurityPolicyPropertiesWithEmbeddedWafPolicy |
Contains properties required to create a security policy. |
| SecurityPolicyWebApplicationFirewall |
The json object containing security policy waf parameters. |
| SecurityPolicyWebApplicationFirewallAssociation |
settings for security policy patterns to match. |
| SecurityPolicyWebApplicationFirewallParametersWithEmbeddedWafPolicy |
Contains security policy waf parameters. |
| 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. |
| SsoUri |
The URI required to login to the supplemental portal from the Azure portal. |
| SupportedOptimizationTypesListResult |
The result of the GetSupportedOptimizationTypes API. |
| 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. |
| ValidateCustomDomainContent |
Input of the custom domain to be validated for DNS mapping. |
| ValidateCustomDomainResult |
Output of custom domain validation. |
| ValidateProbeContent |
Input of the validate probe API. |
| ValidateProbeResult |
Output of the validate probe API. |
| ValidateSecretContent |
Input of the secret to be validated. |
| ValidateSecretResult |
Output of the validated secret. |
| WafMetricsResponse |
Waf Metrics Response. |
| WafMetricsResponseSeriesItem |
The WafMetricsResponseSeriesItem. |
| WafMetricsResponseSeriesPropertiesItemsItem |
The WafMetricsResponseSeriesPropertiesItemsItem. |
| WafPolicyManagedRuleSet |
Defines a managed rule set. |
| WafPolicySettings |
Defines contents of a web application firewall global configuration. |
| WafRankingsResponse |
Waf Rankings Response. |
| WafRankingsResponseDataItem |
The WafRankingsResponseDataItem. |
Structs
| Name | Description |
|---|---|
| AfdCipherSuiteSetType |
cipher suite set type that will be used for Https. |
| AfdCustomizedCipherSuiteForTls12 | |
| AfdCustomizedCipherSuiteForTls13 | |
| CacheBehaviorSetting |
Caching behavior for the requests. |
| CacheExpirationActionType |
The CacheExpirationActionType. |
| CacheKeyQueryStringActionType |
The CacheKeyQueryStringActionType. |
| CanMigrateDefaultSku |
Recommended sku for the migration. |
| CdnCacheLevel |
The level at which the content needs to be cached. |
| CdnCertificateSourceType |
The CdnCertificateSourceType. |
| CdnDeploymentRolloutStatus |
Deployment status of preview stage. |
| CdnEndpointProvisioningState |
Provisioning status of the endpoint. |
| CdnManagedCertificateType |
Type of certificate used. |
| CdnProfileAgentProvisioningState |
Provisioning status of the profile agent association. |
| CdnResourceType |
Type of CDN resource used in CheckNameAvailability. |
| CdnRuleType |
Describes type of rule. |
| CdnSkuName |
Name of the pricing tier. |
| CdnUsageUnit |
Unit of the usage. e.g. count. |
| CdnWebAgentKnowledgeSourceProvisioningState |
Provisioning status of the knowledge source. |
| CdnWebAgentPathType |
The type of the path. |
| CdnWebAgentProvisioningState |
Provisioning status of the web agent. |
| CertificateDeleteAction |
Describes the action that shall be taken when the certificate is removed from Key Vault. |
| CertificateRevocationCheckEnabledState |
Set to Enabled by default. If set to Disabled, revocation status of client certificate chain will be checked before establishing mutual TLS connection. |
| CertificateUpdateAction |
Describes the action that shall be taken when the certificate is updated in Key Vault. |
| ClientPortMatchConditionType |
The ClientPortMatchConditionType. |
| ClientPortOperator |
Describes operator to be matched. |
| CookiesMatchConditionType |
The CookiesMatchConditionType. |
| 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. |
| DeliveryRuleMatchVariable |
Request variable to compare with. |
| DeliveryRuleSslProtocol |
The protocol of an established TLS connection. |
| DeploymentVersiongApprovalStatus | |
| 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. |
| EdgeActionInvocationPoint |
Defines at which point in the request processing pipeline the edge action will be invoked. |
| EnabledState |
Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. |
| EndpointResourceState |
Resource status of the endpoint. |
| EnforceMtlsEnabledState |
Set to Disabled by default. If set to Enabled, only custom domains with mTLS enabled can be added to child Route resources. |
| 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. |
| 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. |
| FrontDoorRouteGrpcState |
Whether or not gRPC is enabled on this route. Permitted values are 'Enabled' or 'Disabled'. |
| FrontDoorUsageUnit |
An enum describing the unit of measurement. |
| HeaderAction |
Action to perform. |
| HeaderActionType |
The HeaderActionType. |
| HostNameMatchConditionType |
The HostNameMatchConditionType. |
| 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. |
| HttpVersionMatchConditionType |
The HttpVersionMatchConditionType. |
| HttpVersionOperator |
Describes operator to be matched. |
| IsDeviceMatchConditionMatchValue | |
| IsDeviceMatchConditionType |
The IsDeviceMatchConditionType. |
| IsDeviceOperator |
Describes operator to be matched. |
| KeyVaultCertificateSourceType |
The KeyVaultCertificateSourceType. |
| KeyVaultSigningKeyType | |
| LinkToDefaultDomain |
whether this route will be linked to the default endpoint domain. |
| LogMetric | |
| LogMetricsGranularity | |
| LogMetricsGroupBy | |
| LogRanking | |
| LogRankingMetric | |
| ManagedRuleExclusionMatchVariable |
The variable type to be excluded. |
| ManagedRuleExclusionSelectorMatchOperator |
Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. |
| ManagedRuleSetActionType |
Defines the action to take when a managed rule set score threshold is met. |
| 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. |
| MetricsResponseGranularity | |
| MetricsResponseSeriesItemUnit | |
| 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. |
| OriginGroupOverrideActionType |
The OriginGroupOverrideActionType. |
| 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. |
| PolicyRequestBodyCheck |
Describes if policy managed rules will inspect the request body content. |
| PolicyResourceState |
Resource status of the policy. |
| PolicySettingsDefaultCustomBlockResponseStatusCode |
If the action type is block, this field defines the default customer overridable http response status code. |
| PostArgsMatchConditionType |
The PostArgsMatchConditionType. |
| 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. |
| QueryStringMatchConditionType |
The QueryStringMatchConditionType. |
| QueryStringOperator |
Describes operator to be matched. |
| RateLimitGroupByVariableName |
Describes the supported variable for group by. |
| RedirectType |
The redirect type the rule will use when redirecting traffic. |
| RemoteAddressMatchConditionType |
The RemoteAddressMatchConditionType. |
| RemoteAddressOperator |
Describes operator to be matched. |
| RequestBodyMatchConditionType |
The RequestBodyMatchConditionType. |
| RequestBodyOperator |
Describes operator to be matched. |
| RequestHeaderMatchConditionType |
The RequestHeaderMatchConditionType. |
| RequestHeaderOperator |
Describes operator to be matched. |
| RequestMethodMatchConditionMatchValue | |
| RequestMethodMatchConditionType |
The RequestMethodMatchConditionType. |
| RequestMethodOperator |
Describes operator to be matched. |
| RequestSchemeMatchConditionMatchValue | |
| RequestSchemeMatchConditionType |
The RequestSchemeMatchConditionType. |
| RequestSchemeOperator |
Describes operator to be matched. |
| RequestUriMatchConditionType |
The RequestUriMatchConditionType. |
| RequestUriOperator |
Describes operator to be matched. |
| RouteConfigurationOverrideActionType |
The RouteConfigurationOverrideActionType. |
| 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. |
| SecretType |
The type of the secret resource. |
| SecureDeliveryProtocolType |
Defines the TLS extension protocol that is used for secure delivery. |
| ServerPortMatchConditionType |
The ServerPortMatchConditionType. |
| ServerPortOperator |
Describes operator to be matched. |
| SocketAddressMatchConditionType |
The SocketAddressMatchConditionType. |
| SocketAddressOperator |
Describes operator to be matched. |
| SslProtocolMatchConditionType |
The SslProtocolMatchConditionType. |
| SslProtocolOperator |
Describes operator to be matched. |
| TransformType |
Describes what transforms were applied before matching. |
| UriFileExtensionMatchConditionType |
The UriFileExtensionMatchConditionType. |
| UriFileExtensionOperator |
Describes operator to be matched. |
| UriFileNameMatchConditionType |
The UriFileNameMatchConditionType. |
| UriFileNameOperator |
Describes operator to be matched. |
| UriPathMatchConditionType |
The UriPathMatchConditionType. |
| UriPathOperator |
Describes operator to be matched. |
| UriRedirectActionType |
The UriRedirectActionType. |
| UriRewriteActionType |
The UriRewriteActionType. |
| UriSigningActionType |
The UriSigningActionType. |
| UriSigningAlgorithm |
Algorithm to use for URL signing. |
| UrlSigningActionTypeName | |
| ValidationStatus |
The validation status. |
| WafAction | |
| WafGranularity | |
| WafMatchVariable |
Match variable to compare against. |
| WafMetric | |
| WafMetricsResponseGranularity | |
| WafMetricsResponseSeriesItemUnit | |
| WafRankingGroupBy | |
| WafRankingType | |
| WafRuleType | |
| WebAgentKnowledgeSourceType |
Format or origin of the knowledge source. |
| WebAgentKnowledgeSourceUpdateFrequency |
Specifies the units of time for scheduling update intervals for the knowledge source. |
| WebApplicationFirewallPolicyProvisioningState |
Provisioning state of the WebApplicationFirewallPolicy. |
| WebApplicationFirewallScrubbingState |
State of the log scrubbing config. Default value is Enabled. |
Enums
| Name | Description |
|---|---|
| CdnMinimumTlsVersion |
TLS protocol version that will be used for Https. |
| FrontDoorMinimumTlsVersion |
TLS protocol version that will be used for Https. |
| GeoFilterAction |
Action of the geo filter, i.e. allow or block access. |
| HealthProbeProtocol |
Protocol to use for health probe. |
| HealthProbeRequestType |
The type of health probe request that is made. |
| 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. |
| ResponseBasedDetectedErrorType |
Type of response errors for real user requests for which origin will be deemed unhealthy. |
| SharedPrivateLinkResourceStatus |
Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. |
