@azure/arm-frontdoor package

Classes

FrontDoorManagementClient

Interfaces

Backend	Backend address of a frontDoor load balancer.
BackendPool	A backend pool is a collection of backends that can be routed to.
BackendPoolProperties	The JSON object that contains the properties required to create a Backend Pool.
BackendPoolUpdateParameters	A collection of backends that can be routed to.
BackendPoolsSettings	Settings that apply to all backend pools.
BasicResource	Common resource representation.
BasicResourceWithSettableIDName	Common resource representation.
CacheConfiguration	Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.
CheckNameAvailabilityInput	Input of CheckNameAvailability API.
CheckNameAvailabilityOutput	Output of check name availability API.
CustomHttpsConfiguration	Https settings for a domain
CustomRule	Defines contents of a web application rule
CustomRuleList	Defines contents of custom rules
DefaultErrorResponse	Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.
DefaultErrorResponseError	Error model.
Endpoint	Defines the endpoint properties
EndpointsOperations	Interface representing a Endpoints operations.
EndpointsPurgeContentOptionalParams	Optional parameters.
ErrorResponse	Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.
Experiment	Defines the properties of an Experiment
ExperimentProperties	Defines the properties of an experiment
ExperimentUpdateModel	Defines modifiable attributes of an Experiment
ExperimentUpdateProperties	Defines the properties of an experiment
ExperimentsCreateOrUpdateOptionalParams	Optional parameters.
ExperimentsDeleteOptionalParams	Optional parameters.
ExperimentsGetOptionalParams	Optional parameters.
ExperimentsListByProfileOptionalParams	Optional parameters.
ExperimentsOperations	Interface representing a Experiments operations.
ExperimentsUpdateOptionalParams	Optional parameters.
ForwardingConfiguration	Describes Forwarding Route.
FrontDoor	Front Door represents a collection of backend endpoints to route traffic to along with rules that specify how traffic is sent there.
FrontDoorCertificateSourceParameters	Parameters required for enabling SSL with Front Door-managed certificates
FrontDoorManagementClientOptionalParams	Optional parameters for the client.
FrontDoorNameAvailabilityCheckOptionalParams	Optional parameters.
FrontDoorNameAvailabilityOperations	Interface representing a FrontDoorNameAvailability operations.
FrontDoorNameAvailabilityWithSubscriptionCheckOptionalParams	Optional parameters.
FrontDoorNameAvailabilityWithSubscriptionOperations	Interface representing a FrontDoorNameAvailabilityWithSubscription operations.
FrontDoorProperties	The JSON object that contains the properties required to create an endpoint.
FrontDoorUpdateParameters	The properties needed to update a Front Door
FrontDoorsCreateOrUpdateOptionalParams	Optional parameters.
FrontDoorsDeleteOptionalParams	Optional parameters.
FrontDoorsGetOptionalParams	Optional parameters.
FrontDoorsListByResourceGroupOptionalParams	Optional parameters.
FrontDoorsListOptionalParams	Optional parameters.
FrontDoorsOperations	Interface representing a FrontDoors operations.
FrontDoorsValidateCustomDomainOptionalParams	Optional parameters.
FrontendEndpoint	A frontend endpoint used for routing.
FrontendEndpointLink	Defines the Resource ID for a Frontend Endpoint.
FrontendEndpointProperties	The JSON object that contains the properties required to create a frontend endpoint.
FrontendEndpointUpdateParameters	Frontend endpoint used in routing rule
FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink	Defines the Web Application Firewall policy for each host (if applicable)
FrontendEndpointsDisableHttpsOptionalParams	Optional parameters.
FrontendEndpointsEnableHttpsOptionalParams	Optional parameters.
FrontendEndpointsGetOptionalParams	Optional parameters.
FrontendEndpointsListByFrontDoorOptionalParams	Optional parameters.
FrontendEndpointsOperations	Interface representing a FrontendEndpoints operations.
GroupByVariable	Describes the variables available to group the rate limit requests
HeaderAction	An action that can manipulate an http header.
HealthProbeSettingsModel	Load balancing settings for a backend pool
HealthProbeSettingsProperties	The JSON object that contains the properties required to create a health probe settings.
HealthProbeSettingsUpdateParameters	L7 health probe settings for a backend pool
KeyVaultCertificateSourceParameters	Parameters required for bring-your-own-certification via Key Vault
KeyVaultCertificateSourceParametersVault	The Key Vault containing the SSL certificate
LatencyMetric	Defines the properties of a latency metric used in the latency scorecard
LatencyScorecard	Defines the LatencyScorecard
LatencyScorecardProperties	Defines a the properties of a Latency Scorecard
LoadBalancingSettingsModel	Load balancing settings for a backend pool
LoadBalancingSettingsProperties	The JSON object that contains the properties required to create load balancing settings
LoadBalancingSettingsUpdateParameters	Round-Robin load balancing settings for a backend pool
ManagedRuleDefinition	Describes a managed rule definition.
ManagedRuleExclusion	Exclude variables from managed rule evaluation.
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 the a managed rule set definition.
ManagedRuleSetDefinitionProperties	Properties for a managed rule set definition.
ManagedRuleSetException	Excludes whole requests from managed rule evaluation according to match conditions.
ManagedRuleSetExceptionList	Defines the list of exceptions for the managed rule sets.
ManagedRuleSetList	Defines the list of managed rule sets for the policy.
ManagedRuleSetScope	Defines the scope of the managed rules.
ManagedRuleSetsListOptionalParams	Optional parameters.
ManagedRuleSetsOperations	Interface representing a ManagedRuleSets operations.
MatchCondition	Define a match condition.
NetworkExperimentProfilesCreateOrUpdateOptionalParams	Optional parameters.
NetworkExperimentProfilesDeleteOptionalParams	Optional parameters.
NetworkExperimentProfilesGetOptionalParams	Optional parameters.
NetworkExperimentProfilesListByResourceGroupOptionalParams	Optional parameters.
NetworkExperimentProfilesListOptionalParams	Optional parameters.
NetworkExperimentProfilesOperations	Interface representing a NetworkExperimentProfiles operations.
NetworkExperimentProfilesUpdateOptionalParams	Optional parameters.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PoliciesCreateOrUpdateOptionalParams	Optional parameters.
PoliciesDeleteOptionalParams	Optional parameters.
PoliciesGetOptionalParams	Optional parameters.
PoliciesListBySubscriptionOptionalParams	Optional parameters.
PoliciesListOptionalParams	Optional parameters.
PoliciesOperations	Interface representing a Policies operations.
PoliciesUpdateOptionalParams	Optional parameters.
PolicySettings	Defines top-level WebApplicationFirewallPolicy configuration settings.
PolicySettingsLogScrubbing	Defines rules that scrub sensitive fields in the Web Application Firewall logs.
PreconfiguredEndpoint	Defines the properties of a preconfigured endpoint
PreconfiguredEndpointProperties	Defines the properties of a preconfigured endpoint
PreconfiguredEndpointsListOptionalParams	Optional parameters.
PreconfiguredEndpointsOperations	Interface representing a PreconfiguredEndpoints operations.
Profile	Defines an Network Experiment Profile and lists of Experiments
ProfileProperties	Defines the properties of an experiment
ProfileUpdateModel	Defines modifiable attributes of a Profile
ProfileUpdateProperties	Defines the properties of an experiment
PurgeParameters	Parameters required for content purge.
RedirectConfiguration	Describes Redirect Route.
ReportsGetLatencyScorecardsOptionalParams	Optional parameters.
ReportsGetTimeseriesOptionalParams	Optional parameters.
ReportsOperations	Interface representing a Reports operations.
Resource	Common resource representation.
ResourcewithSettableName	Common resource representation.
RestorePollerOptions
RouteConfiguration	Base class for all types of Route.
RoutingRule	A routing rule represents a specification for traffic to treat and where to send it, along with health probe information.
RoutingRuleLink	Defines the Resource ID for a Routing Rule.
RoutingRuleProperties	The JSON object that contains the properties required to create a routing rule.
RoutingRuleUpdateParameters	Routing rules to apply to an endpoint
RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink	Defines the Web Application Firewall policy for each routing rule (if applicable)
RuleGroupScope	Defines the scope of the rule group.
RuleScope	Defines the scope of the rule.
RulesEngine	A rules engine configuration containing a list of rules that will run to modify the runtime behavior of the request and response.
RulesEngineAction	One or more actions that will execute, modifying the request and/or response.
RulesEngineMatchCondition	Define a match condition
RulesEngineProperties	The JSON object that contains the properties required to create a Rules Engine Configuration.
RulesEngineRule	Contains a list of match conditions, and an action on how to modify the request/response. If multiple rules match, the actions from one rule that conflict with a previous rule overwrite for a singular action, or append in the case of headers manipulation.
RulesEngineUpdateParameters	Rules Engine Configuration to apply to a Routing Rule.
RulesEnginesCreateOrUpdateOptionalParams	Optional parameters.
RulesEnginesDeleteOptionalParams	Optional parameters.
RulesEnginesGetOptionalParams	Optional parameters.
RulesEnginesListByFrontDoorOptionalParams	Optional parameters.
RulesEnginesOperations	Interface representing a RulesEngines operations.
SecurityPolicyLink	Defines the Resource ID for a Security Policy.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	The pricing tier of the web application firewall policy.
SubResource	Reference to another subresource.
TagsObject	Tags object for patch operations.
Timeseries	Defines the Timeseries
TimeseriesDataPoint	Defines a timeseries datapoint used in a timeseries
TimeseriesProperties	Defines the properties of a timeseries
ValidateCustomDomainInput	Input of the custom domain to be validated for DNS mapping.
ValidateCustomDomainOutput	Output of custom domain validation.
WebApplicationFirewallPolicy	Defines web application firewall policy.
WebApplicationFirewallPolicyProperties	Defines web application firewall policy properties.
WebApplicationFirewallScrubbingRules	Defines the contents of the log scrubbing rules.

Type Aliases

ActionType	Defines the action to take on rule match. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Allow: Allow Block: Block Log: Log Redirect: Redirect AnomalyScoring: AnomalyScoring JSChallenge: JSChallenge CAPTCHA: CAPTCHA
AggregationInterval	The aggregation interval of the Timeseries KnownAggregationInterval can be used interchangeably with AggregationInterval, this enum contains the known values that the service supports. Known values supported by the service Hourly: Hourly Daily: Daily
Availability	Indicates whether the name is available. KnownAvailability can be used interchangeably with Availability, this enum contains the known values that the service supports. Known values supported by the service Available: Available Unavailable: Unavailable
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BackendEnabledState	Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled' KnownBackendEnabledState can be used interchangeably with BackendEnabledState, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled
ContinuablePage	An interface that describes a page of results.
CustomHttpsProvisioningState	Provisioning status of Custom Https of the frontendEndpoint. KnownCustomHttpsProvisioningState can be used interchangeably with CustomHttpsProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Enabling: Enabling Enabled: Enabled Disabling: Disabling Disabled: Disabled Failed: Failed
CustomHttpsProvisioningSubstate	Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. KnownCustomHttpsProvisioningSubstate can be used interchangeably with CustomHttpsProvisioningSubstate, this enum contains the known values that the service supports. Known values supported by the service SubmittingDomainControlValidationRequest: SubmittingDomainControlValidationRequest PendingDomainControlValidationREquestApproval: PendingDomainControlValidationREquestApproval DomainControlValidationRequestApproved: DomainControlValidationRequestApproved DomainControlValidationRequestRejected: DomainControlValidationRequestRejected DomainControlValidationRequestTimedOut: DomainControlValidationRequestTimedOut IssuingCertificate: IssuingCertificate DeployingCertificate: DeployingCertificate CertificateDeployed: CertificateDeployed DeletingCertificate: DeletingCertificate CertificateDeleted: CertificateDeleted
CustomRuleEnabledState	Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. KnownCustomRuleEnabledState can be used interchangeably with CustomRuleEnabledState, this enum contains the known values that the service supports. Known values supported by the service Disabled: Disabled Enabled: Enabled
DynamicCompressionEnabled	Whether to use dynamic compression for cached content KnownDynamicCompressionEnabled can be used interchangeably with DynamicCompressionEnabled, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled
EndpointType	The type of endpoint KnownEndpointType can be used interchangeably with EndpointType, this enum contains the known values that the service supports. Known values supported by the service AFD: AFD AzureRegion: AzureRegion CDN: CDN ATM: ATM
EnforceCertificateNameCheckEnabledState	Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. KnownEnforceCertificateNameCheckEnabledState can be used interchangeably with EnforceCertificateNameCheckEnabledState, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled
ExceptionMatchVariable	The variable to be evaluated for excluding the request. KnownExceptionMatchVariable can be used interchangeably with ExceptionMatchVariable, this enum contains the known values that the service supports. Known values supported by the service RequestUri: Request Uri Exception Match Variable SocketAddr: Socket Address Exception Match Variable RequestHeaderNames: Request Header Names Exception Match Variable
ExceptionSelectorMatchOperator	Comparison operator to apply to the selector when specifying which elements in the collection this exception applies to.. KnownExceptionSelectorMatchOperator can be used interchangeably with ExceptionSelectorMatchOperator, this enum contains the known values that the service supports. Known values supported by the service Equals: Equals Selector Match Operator
ExceptionValueMatchOperator	Comparison operator to apply to the value to be matched.. KnownExceptionValueMatchOperator can be used interchangeably with ExceptionValueMatchOperator, this enum contains the known values that the service supports. Known values supported by the service Equals: Equals Exception Value Match Operator Contains: Contains Exception Value Match Operator StartsWith: StartsWith Exception Value Match Operator EndsWith: EndsWith Exception Value Match Operator EqualsAny: EqualsAny Exception Value Match Operator IPMatch: IPMatch Exception Value Match Operator
FrontDoorCertificateSource	Defines the source of the SSL certificate KnownFrontDoorCertificateSource can be used interchangeably with FrontDoorCertificateSource, this enum contains the known values that the service supports. Known values supported by the service AzureKeyVault: AzureKeyVault FrontDoor: FrontDoor
FrontDoorCertificateType	Defines the type of the certificate used for secure connections to a frontendEndpoint KnownFrontDoorCertificateType can be used interchangeably with FrontDoorCertificateType, this enum contains the known values that the service supports. Known values supported by the service Dedicated: Dedicated
FrontDoorEnabledState	Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' KnownFrontDoorEnabledState can be used interchangeably with FrontDoorEnabledState, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled
FrontDoorForwardingProtocol	Protocol this rule will use when forwarding traffic to backends. KnownFrontDoorForwardingProtocol can be used interchangeably with FrontDoorForwardingProtocol, this enum contains the known values that the service supports. Known values supported by the service HttpOnly: HttpOnly HttpsOnly: HttpsOnly MatchRequest: MatchRequest
FrontDoorHealthProbeMethod	Configures which HTTP method to use to probe the backends defined under backendPools. KnownFrontDoorHealthProbeMethod can be used interchangeably with FrontDoorHealthProbeMethod, this enum contains the known values that the service supports. Known values supported by the service GET: GET HEAD: HEAD
FrontDoorProtocol	Accepted protocol schemes. KnownFrontDoorProtocol can be used interchangeably with FrontDoorProtocol, this enum contains the known values that the service supports. Known values supported by the service Http: Http Https: Https
FrontDoorQuery	Treatment of URL query terms when forming the cache key. KnownFrontDoorQuery can be used interchangeably with FrontDoorQuery, this enum contains the known values that the service supports. Known values supported by the service StripNone: StripNone StripAll: StripAll StripOnly: StripOnly StripAllExcept: StripAllExcept
FrontDoorRedirectProtocol	The protocol of the destination to where the traffic is redirected KnownFrontDoorRedirectProtocol can be used interchangeably with FrontDoorRedirectProtocol, this enum contains the known values that the service supports. Known values supported by the service HttpOnly: HttpOnly HttpsOnly: HttpsOnly MatchRequest: MatchRequest
FrontDoorRedirectType	The redirect type the rule will use when redirecting traffic. KnownFrontDoorRedirectType can be used interchangeably with FrontDoorRedirectType, this enum contains the known values that the service supports. Known values supported by the service Moved: Moved Found: Found TemporaryRedirect: TemporaryRedirect PermanentRedirect: PermanentRedirect
FrontDoorResourceState	Resource status of the Front Door or Front Door SubResource. KnownFrontDoorResourceState can be used interchangeably with FrontDoorResourceState, this enum contains the known values that the service supports. Known values supported by the service Creating: Creating Enabling: Enabling Enabled: Enabled Disabling: Disabling Disabled: Disabled Deleting: Deleting Migrating: Migrating Migrated: Migrated
FrontDoorTlsProtocolType	Defines the TLS extension protocol that is used for secure delivery KnownFrontDoorTlsProtocolType can be used interchangeably with FrontDoorTlsProtocolType, this enum contains the known values that the service supports. Known values supported by the service ServerNameIndication: ServerNameIndication
HeaderActionType	Which type of manipulation to apply to the header. KnownHeaderActionType can be used interchangeably with HeaderActionType, this enum contains the known values that the service supports. Known values supported by the service Append: Append Delete: Delete Overwrite: Overwrite
HealthProbeEnabled	Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. KnownHealthProbeEnabled can be used interchangeably with HealthProbeEnabled, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled
LatencyScorecardAggregationInterval	Type of LatencyScorecardAggregationInterval
ManagedRuleEnabledState	Describes if the managed rule is in enabled or disabled state. KnownManagedRuleEnabledState can be used interchangeably with ManagedRuleEnabledState, this enum contains the known values that the service supports. Known values supported by the service Disabled: Disabled Enabled: Enabled
ManagedRuleExclusionMatchVariable	The variable type to be excluded. KnownManagedRuleExclusionMatchVariable can be used interchangeably with ManagedRuleExclusionMatchVariable, this enum contains the known values that the service supports. Known values supported by the service RequestHeaderNames: RequestHeaderNames RequestCookieNames: RequestCookieNames QueryStringArgNames: QueryStringArgNames RequestBodyPostArgNames: RequestBodyPostArgNames RequestBodyJsonArgNames: RequestBodyJsonArgNames
ManagedRuleExclusionSelectorMatchOperator	Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. KnownManagedRuleExclusionSelectorMatchOperator can be used interchangeably with ManagedRuleExclusionSelectorMatchOperator, this enum contains the known values that the service supports. Known values supported by the service Equals: Equals Contains: Contains StartsWith: StartsWith EndsWith: EndsWith EqualsAny: EqualsAny
ManagedRuleSetActionType	Defines the action to take when a managed rule set score threshold is met. KnownManagedRuleSetActionType can be used interchangeably with ManagedRuleSetActionType, this enum contains the known values that the service supports. Known values supported by the service Block: Block Log: Log Redirect: Redirect
MatchProcessingBehavior	If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. KnownMatchProcessingBehavior can be used interchangeably with MatchProcessingBehavior, this enum contains the known values that the service supports. Known values supported by the service Continue: Continue Stop: Stop
MatchVariable	Request variable to compare with. KnownMatchVariable can be used interchangeably with MatchVariable, this enum contains the known values that the service supports. Known values supported by the service RemoteAddr: RemoteAddr RequestMethod: RequestMethod QueryString: QueryString PostArgs: PostArgs RequestUri: RequestUri RequestHeader: RequestHeader RequestBody: RequestBody Cookies: Cookies SocketAddr: SocketAddr JA4: JA4 Match Variable
MinimumTLSVersion	The minimum TLS version required from the clients to establish an SSL handshake with Front Door. KnownMinimumTLSVersion can be used interchangeably with MinimumTLSVersion, this enum contains the known values that the service supports. Known values supported by the service 1.0: 1.0 1.2: 1.2
NetworkExperimentResourceState	Defines the server side resource status KnownNetworkExperimentResourceState can be used interchangeably with NetworkExperimentResourceState, this enum contains the known values that the service supports. Known values supported by the service Creating: Creating Enabling: Enabling Enabled: Enabled Disabling: Disabling Disabled: Disabled Deleting: Deleting
Operator	Comparison type to use for matching with the variable value. KnownOperator can be used interchangeably with Operator, this enum contains the known values that the service supports. Known values supported by the service Any: Any IPMatch: IPMatch GeoMatch: GeoMatch Equal: Equal Contains: Contains LessThan: LessThan GreaterThan: GreaterThan LessThanOrEqual: LessThanOrEqual GreaterThanOrEqual: GreaterThanOrEqual BeginsWith: BeginsWith EndsWith: EndsWith RegEx: RegEx ServiceTagMatch: ServiceTagMatch AsnMatch: Autonomous System Number Match Operator ClientFingerprint: Client Finger print Operator
PolicyEnabledState	Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. KnownPolicyEnabledState can be used interchangeably with PolicyEnabledState, this enum contains the known values that the service supports. Known values supported by the service Disabled: Disabled Enabled: Enabled
PolicyMode	Describes if it is in detection mode or prevention mode at policy level. KnownPolicyMode can be used interchangeably with PolicyMode, this enum contains the known values that the service supports. Known values supported by the service Prevention: Prevention Detection: Detection
PolicyRequestBodyCheck	Describes if policy managed rules will inspect the request body content. KnownPolicyRequestBodyCheck can be used interchangeably with PolicyRequestBodyCheck, this enum contains the known values that the service supports. Known values supported by the service Disabled: Disabled Enabled: Enabled
PolicyResourceState	Resource status of the policy. KnownPolicyResourceState can be used interchangeably with PolicyResourceState, this enum contains the known values that the service supports. Known values supported by the service Creating: Creating Enabling: Enabling Enabled: Enabled Disabling: Disabling Disabled: Disabled Deleting: Deleting
PrivateEndpointStatus	The Approval status for the connection to the Private Link KnownPrivateEndpointStatus can be used interchangeably with PrivateEndpointStatus, this enum contains the known values that the service supports. Known values supported by the service Pending: Pending Approved: Approved Rejected: Rejected Disconnected: Disconnected Timeout: Timeout
ResourceType	Type of Front Door resource used in CheckNameAvailability.
RouteConfigurationUnion	Alias for RouteConfigurationUnion
RoutingRuleEnabledState	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' KnownRoutingRuleEnabledState can be used interchangeably with RoutingRuleEnabledState, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled
RuleType	Describes type of rule. KnownRuleType can be used interchangeably with RuleType, this enum contains the known values that the service supports. Known values supported by the service MatchRule: MatchRule RateLimitRule: RateLimitRule
RulesEngineMatchVariable	Match Variable KnownRulesEngineMatchVariable can be used interchangeably with RulesEngineMatchVariable, this enum contains the known values that the service supports. Known values supported by the service IsMobile: IsMobile RemoteAddr: RemoteAddr RequestMethod: RequestMethod QueryString: QueryString PostArgs: PostArgs RequestUri: RequestUri RequestPath: RequestPath RequestFilename: RequestFilename RequestFilenameExtension: RequestFilenameExtension RequestHeader: RequestHeader RequestBody: RequestBody RequestScheme: RequestScheme
RulesEngineOperator	Describes operator to apply to the match condition. KnownRulesEngineOperator can be used interchangeably with RulesEngineOperator, this enum contains the known values that the service supports. Known values supported by the service Any: Any IPMatch: IPMatch GeoMatch: GeoMatch Equal: Equal Contains: Contains LessThan: LessThan GreaterThan: GreaterThan LessThanOrEqual: LessThanOrEqual GreaterThanOrEqual: GreaterThanOrEqual BeginsWith: BeginsWith EndsWith: EndsWith
ScrubbingRuleEntryMatchOperator	When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. KnownScrubbingRuleEntryMatchOperator can be used interchangeably with ScrubbingRuleEntryMatchOperator, this enum contains the known values that the service supports. Known values supported by the service EqualsAny: EqualsAny Equals: Equals
ScrubbingRuleEntryMatchVariable	The variable to be scrubbed from the logs. KnownScrubbingRuleEntryMatchVariable can be used interchangeably with ScrubbingRuleEntryMatchVariable, this enum contains the known values that the service supports. Known values supported by the service RequestIPAddress: RequestIPAddress RequestUri: RequestUri QueryStringArgNames: QueryStringArgNames RequestHeaderNames: RequestHeaderNames RequestCookieNames: RequestCookieNames RequestBodyPostArgNames: RequestBodyPostArgNames RequestBodyJsonArgNames: RequestBodyJsonArgNames
ScrubbingRuleEntryState	Defines the state of a log scrubbing rule. Default value is enabled. KnownScrubbingRuleEntryState can be used interchangeably with ScrubbingRuleEntryState, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled
SensitivityType	Defines the sensitivity for the rule. KnownSensitivityType can be used interchangeably with SensitivityType, this enum contains the known values that the service supports. Known values supported by the service Low: Low Sensitivity - triggers the rule by larger spikes in traffic Medium: Medium Sensitivity - triggers the rule by moderate spikes in traffic High: High Sensitivity - triggers the rule by smaller spikes in traffic
SessionAffinityEnabledState	Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled' KnownSessionAffinityEnabledState can be used interchangeably with SessionAffinityEnabledState, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled
SkuName	Name of the pricing tier. KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports. Known values supported by the service Classic_AzureFrontDoor: Classic_AzureFrontDoor Standard_AzureFrontDoor: Standard_AzureFrontDoor Premium_AzureFrontDoor: Premium_AzureFrontDoor
State	The state of the Experiment KnownState can be used interchangeably with State, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled
TimeseriesAggregationInterval	Type of TimeseriesAggregationInterval
TimeseriesType	The type of Timeseries KnownTimeseriesType can be used interchangeably with TimeseriesType, this enum contains the known values that the service supports. Known values supported by the service MeasurementCounts: MeasurementCounts LatencyP50: LatencyP50 LatencyP75: LatencyP75 LatencyP95: LatencyP95
Transform	Describes what transforms are applied before matching KnownTransform can be used interchangeably with Transform, this enum contains the known values that the service supports. Known values supported by the service Lowercase: Lowercase Uppercase: Uppercase Trim: Trim UrlDecode: UrlDecode UrlEncode: UrlEncode RemoveNulls: RemoveNulls
TransformType	Describes what transforms applied before matching. KnownTransformType can be used interchangeably with TransformType, this enum contains the known values that the service supports. Known values supported by the service Lowercase: Lowercase Uppercase: Uppercase Trim: Trim UrlDecode: UrlDecode UrlEncode: UrlEncode RemoveNulls: RemoveNulls
VariableName	Describes the supported variable for group by KnownVariableName can be used interchangeably with VariableName, this enum contains the known values that the service supports. Known values supported by the service SocketAddr: SocketAddr GeoLocation: GeoLocation None: None
WebApplicationFirewallScrubbingState	State of the log scrubbing config. Default value is Enabled. KnownWebApplicationFirewallScrubbingState can be used interchangeably with WebApplicationFirewallScrubbingState, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Defines the action to take on rule match.
KnownAggregationInterval	The aggregation interval of the Timeseries
KnownAvailability	Indicates whether the name is available.
KnownBackendEnabledState	Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'
KnownCustomHttpsProvisioningState	Provisioning status of Custom Https of the frontendEndpoint.
KnownCustomHttpsProvisioningSubstate	Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
KnownCustomRuleEnabledState	Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.
KnownDynamicCompressionEnabled	Whether to use dynamic compression for cached content
KnownEndpointType	The type of endpoint
KnownEnforceCertificateNameCheckEnabledState	Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests.
KnownExceptionMatchVariable	The variable to be evaluated for excluding the request.
KnownExceptionSelectorMatchOperator	Comparison operator to apply to the selector when specifying which elements in the collection this exception applies to..
KnownExceptionValueMatchOperator	Comparison operator to apply to the value to be matched..
KnownFrontDoorCertificateSource	Defines the source of the SSL certificate
KnownFrontDoorCertificateType	Defines the type of the certificate used for secure connections to a frontendEndpoint
KnownFrontDoorEnabledState	Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'
KnownFrontDoorForwardingProtocol	Protocol this rule will use when forwarding traffic to backends.
KnownFrontDoorHealthProbeMethod	Configures which HTTP method to use to probe the backends defined under backendPools.
KnownFrontDoorProtocol	Accepted protocol schemes.
KnownFrontDoorQuery	Treatment of URL query terms when forming the cache key.
KnownFrontDoorRedirectProtocol	The protocol of the destination to where the traffic is redirected
KnownFrontDoorRedirectType	The redirect type the rule will use when redirecting traffic.
KnownFrontDoorResourceState	Resource status of the Front Door or Front Door SubResource.
KnownFrontDoorTlsProtocolType	Defines the TLS extension protocol that is used for secure delivery
KnownHeaderActionType	Which type of manipulation to apply to the header.
KnownHealthProbeEnabled	Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
KnownLatencyScorecardAggregationInterval	Known values of LatencyScorecardAggregationInterval that the service accepts.
KnownManagedRuleEnabledState	Describes if the managed rule is in enabled or disabled state.
KnownManagedRuleExclusionMatchVariable	The variable type to be excluded.
KnownManagedRuleExclusionSelectorMatchOperator	Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to.
KnownManagedRuleSetActionType	Defines the action to take when a managed rule set score threshold is met.
KnownMatchProcessingBehavior	If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.
KnownMatchVariable	Request variable to compare with.
KnownMinimumTLSVersion	The minimum TLS version required from the clients to establish an SSL handshake with Front Door.
KnownNetworkExperimentResourceState	Defines the server side resource status
KnownOperator	Comparison type to use for matching with the variable value.
KnownPolicyEnabledState	Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified.
KnownPolicyMode	Describes if it is in detection mode or prevention mode at policy level.
KnownPolicyRequestBodyCheck	Describes if policy managed rules will inspect the request body content.
KnownPolicyResourceState	Resource status of the policy.
KnownPrivateEndpointStatus	The Approval status for the connection to the Private Link
KnownRoutingRuleEnabledState	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
KnownRuleType	Describes type of rule.
KnownRulesEngineMatchVariable	Match Variable
KnownRulesEngineOperator	Describes operator to apply to the match condition.
KnownScrubbingRuleEntryMatchOperator	When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.
KnownScrubbingRuleEntryMatchVariable	The variable to be scrubbed from the logs.
KnownScrubbingRuleEntryState	Defines the state of a log scrubbing rule. Default value is enabled.
KnownSensitivityType	Defines the sensitivity for the rule.
KnownSessionAffinityEnabledState	Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
KnownSkuName	Name of the pricing tier.
KnownState	The state of the Experiment
KnownTimeseriesAggregationInterval	Known values of TimeseriesAggregationInterval that the service accepts.
KnownTimeseriesType	The type of Timeseries
KnownTransform	Describes what transforms are applied before matching
KnownTransformType	Describes what transforms applied before matching.
KnownVariableName	Describes the supported variable for group by
KnownVersions	The available API versions.
KnownWebApplicationFirewallScrubbingState	State of the log scrubbing config. Default value is Enabled.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(FrontDoorManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(FrontDoorManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: FrontDoorManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

FrontDoorManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor