@azure/arm-frontdoor package

Classes

FrontDoorManagementClient

Interfaces

AzureAsyncOperationResult

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Backend

Backend address of a frontDoor load balancer.

BackendPool

A backend pool is a collection of backends that can be routed to.

BackendPoolListResult

Result of the request to list Backend Pools. It contains a list of Backend Pools objects and a URL link to get the next set of results.

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.

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

Endpoints

Interface representing a Endpoints.

EndpointsPurgeContentOptionalParams

Optional parameters.

ErrorDetails
ErrorModel
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

ExperimentList

Defines a list of Experiments. It contains a list of Experiment objects and a URL link to get the next set of results.

ExperimentUpdateModel

Defines modifiable attributes of an Experiment

Experiments

Interface representing a Experiments.

ExperimentsCreateOrUpdateOptionalParams

Optional parameters.

ExperimentsDeleteOptionalParams

Optional parameters.

ExperimentsGetOptionalParams

Optional parameters.

ExperimentsListByProfileNextOptionalParams

Optional parameters.

ExperimentsListByProfileOptionalParams

Optional parameters.

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.

FrontDoorListResult

Result of the request to list Front Doors. It contains a list of Front Door objects and a URL link to get the next set of results.

FrontDoorManagementClientOptionalParams

Optional parameters.

FrontDoorNameAvailability

Interface representing a FrontDoorNameAvailability.

FrontDoorNameAvailabilityCheckOptionalParams

Optional parameters.

FrontDoorNameAvailabilityWithSubscription

Interface representing a FrontDoorNameAvailabilityWithSubscription.

FrontDoorNameAvailabilityWithSubscriptionCheckOptionalParams

Optional parameters.

FrontDoorProperties

The JSON object that contains the properties required to create an endpoint.

FrontDoorUpdateParameters

The properties needed to update a Front Door

FrontDoors

Interface representing a FrontDoors.

FrontDoorsCreateOrUpdateOptionalParams

Optional parameters.

FrontDoorsDeleteOptionalParams

Optional parameters.

FrontDoorsGetOptionalParams

Optional parameters.

FrontDoorsListByResourceGroupNextOptionalParams

Optional parameters.

FrontDoorsListByResourceGroupOptionalParams

Optional parameters.

FrontDoorsListNextOptionalParams

Optional parameters.

FrontDoorsListOptionalParams

Optional parameters.

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)

FrontendEndpoints

Interface representing a FrontendEndpoints.

FrontendEndpointsDisableHttpsOptionalParams

Optional parameters.

FrontendEndpointsEnableHttpsOptionalParams

Optional parameters.

FrontendEndpointsGetOptionalParams

Optional parameters.

FrontendEndpointsListByFrontDoorNextOptionalParams

Optional parameters.

FrontendEndpointsListByFrontDoorOptionalParams

Optional parameters.

FrontendEndpointsListResult

Result of the request to list frontend endpoints. It contains a list of Frontend endpoint objects and a URL link to get the next set of results.

GroupByVariable

Describes the variables available to group the rate limit requests

HeaderAction

An action that can manipulate an http header.

HealthProbeSettingsListResult

Result of the request to list HealthProbeSettings. It contains a list of HealthProbeSettings objects and a URL link to get the next set of results.

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

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

LoadBalancingSettingsListResult

Result of the request to list load balancing settings. It contains a list of load balancing settings objects and a URL link to get the next set of results.

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.

ManagedRuleSetDefinitionList

List of managed rule set definitions available for use in a policy.

ManagedRuleSetList

Defines the list of managed rule sets for the policy.

ManagedRuleSets

Interface representing a ManagedRuleSets.

ManagedRuleSetsListNextOptionalParams

Optional parameters.

ManagedRuleSetsListOptionalParams

Optional parameters.

MatchCondition

Define a match condition.

NetworkExperimentProfiles

Interface representing a NetworkExperimentProfiles.

NetworkExperimentProfilesCreateOrUpdateOptionalParams

Optional parameters.

NetworkExperimentProfilesDeleteOptionalParams

Optional parameters.

NetworkExperimentProfilesGetOptionalParams

Optional parameters.

NetworkExperimentProfilesListByResourceGroupNextOptionalParams

Optional parameters.

NetworkExperimentProfilesListByResourceGroupOptionalParams

Optional parameters.

NetworkExperimentProfilesListNextOptionalParams

Optional parameters.

NetworkExperimentProfilesListOptionalParams

Optional parameters.

NetworkExperimentProfilesUpdateOptionalParams

Optional parameters.

Policies

Interface representing a Policies.

PoliciesCreateOrUpdateOptionalParams

Optional parameters.

PoliciesDeleteOptionalParams

Optional parameters.

PoliciesGetOptionalParams

Optional parameters.

PoliciesListBySubscriptionNextOptionalParams

Optional parameters.

PoliciesListBySubscriptionOptionalParams

Optional parameters.

PoliciesListNextOptionalParams

Optional parameters.

PoliciesListOptionalParams

Optional parameters.

PoliciesUpdateOptionalParams

Optional parameters.

PolicySettings

Defines top-level WebApplicationFirewallPolicy configuration settings.

PreconfiguredEndpoint

Defines the properties of a preconfigured endpoint

PreconfiguredEndpointList

Defines a list of preconfigured endpoints.

PreconfiguredEndpoints

Interface representing a PreconfiguredEndpoints.

PreconfiguredEndpointsListNextOptionalParams

Optional parameters.

PreconfiguredEndpointsListOptionalParams

Optional parameters.

Profile

Defines an Network Experiment Profile and lists of Experiments

ProfileList

Defines a list of Profiles. It contains a list of Profile objects and a URL link to get the next set of results.

ProfileUpdateModel

Defines modifiable attributes of a Profile

PurgeParameters

Parameters required for content purge.

RedirectConfiguration

Describes Redirect Route.

Reports

Interface representing a Reports.

ReportsGetLatencyScorecardsOptionalParams

Optional parameters.

ReportsGetTimeseriesOptionalParams

Optional parameters.

Resource

Common resource representation.

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.

RoutingRuleListResult

Result of the request to list Routing Rules. It contains a list of Routing Rule objects and a URL link to get the next set of results.

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)

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.

RulesEngineListResult

Result of the request to list Rules Engine Configurations. It contains a list of RulesEngine objects and a URL link to get the next set of results.

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.

RulesEngines

Interface representing a RulesEngines.

RulesEnginesCreateOrUpdateOptionalParams

Optional parameters.

RulesEnginesDeleteOptionalParams

Optional parameters.

RulesEnginesGetOptionalParams

Optional parameters.

RulesEnginesListByFrontDoorNextOptionalParams

Optional parameters.

RulesEnginesListByFrontDoorOptionalParams

Optional parameters.

SecurityPolicyLink

Defines the Resource ID for a Security Policy.

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

ValidateCustomDomainInput

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

ValidateCustomDomainOutput

Output of custom domain validation.

WebApplicationFirewallPolicy

Defines web application firewall policy.

WebApplicationFirewallPolicyList

Defines a list of WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.

WebApplicationFirewallScrubbingRules

Defines the contents of the log scrubbing rules.

Type Aliases

ActionType

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Allow
Block
Log
Redirect
AnomalyScoring
JSChallenge

AggregationInterval

Defines values for AggregationInterval.
KnownAggregationInterval can be used interchangeably with AggregationInterval, this enum contains the known values that the service supports.

Known values supported by the service

Hourly
Daily

Availability

Defines values for Availability.
KnownAvailability can be used interchangeably with Availability, this enum contains the known values that the service supports.

Known values supported by the service

Available
Unavailable

BackendEnabledState

Defines values for BackendEnabledState.
KnownBackendEnabledState can be used interchangeably with BackendEnabledState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

CustomHttpsProvisioningState

Defines values for CustomHttpsProvisioningState.
KnownCustomHttpsProvisioningState can be used interchangeably with CustomHttpsProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Enabling
Enabled
Disabling
Disabled
Failed

CustomHttpsProvisioningSubstate

Defines values for CustomHttpsProvisioningSubstate.
KnownCustomHttpsProvisioningSubstate can be used interchangeably with CustomHttpsProvisioningSubstate, this enum contains the known values that the service supports.

Known values supported by the service

SubmittingDomainControlValidationRequest
PendingDomainControlValidationREquestApproval
DomainControlValidationRequestApproved
DomainControlValidationRequestRejected
DomainControlValidationRequestTimedOut
IssuingCertificate
DeployingCertificate
CertificateDeployed
DeletingCertificate
CertificateDeleted

CustomRuleEnabledState

Defines values for CustomRuleEnabledState.
KnownCustomRuleEnabledState can be used interchangeably with CustomRuleEnabledState, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

DynamicCompressionEnabled

Defines values for DynamicCompressionEnabled.
KnownDynamicCompressionEnabled can be used interchangeably with DynamicCompressionEnabled, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

EndpointType

Defines values for EndpointType.
KnownEndpointType can be used interchangeably with EndpointType, this enum contains the known values that the service supports.

Known values supported by the service

AFD
AzureRegion
CDN
ATM

EnforceCertificateNameCheckEnabledState

Defines values for EnforceCertificateNameCheckEnabledState.
KnownEnforceCertificateNameCheckEnabledState can be used interchangeably with EnforceCertificateNameCheckEnabledState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

ExperimentsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ExperimentsGetResponse

Contains response data for the get operation.

ExperimentsListByProfileNextResponse

Contains response data for the listByProfileNext operation.

ExperimentsListByProfileResponse

Contains response data for the listByProfile operation.

ExperimentsUpdateResponse

Contains response data for the update operation.

FrontDoorCertificateSource

Defines values for FrontDoorCertificateSource.
KnownFrontDoorCertificateSource can be used interchangeably with FrontDoorCertificateSource, this enum contains the known values that the service supports.

Known values supported by the service

AzureKeyVault
FrontDoor

FrontDoorCertificateType

Defines values for FrontDoorCertificateType.
KnownFrontDoorCertificateType can be used interchangeably with FrontDoorCertificateType, this enum contains the known values that the service supports.

Known values supported by the service

Dedicated

FrontDoorEnabledState

Defines values for FrontDoorEnabledState.
KnownFrontDoorEnabledState can be used interchangeably with FrontDoorEnabledState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

FrontDoorForwardingProtocol

Defines values for FrontDoorForwardingProtocol.
KnownFrontDoorForwardingProtocol can be used interchangeably with FrontDoorForwardingProtocol, this enum contains the known values that the service supports.

Known values supported by the service

HttpOnly
HttpsOnly
MatchRequest

FrontDoorHealthProbeMethod

Defines values for FrontDoorHealthProbeMethod.
KnownFrontDoorHealthProbeMethod can be used interchangeably with FrontDoorHealthProbeMethod, this enum contains the known values that the service supports.

Known values supported by the service

GET
HEAD

FrontDoorNameAvailabilityCheckResponse

Contains response data for the check operation.

FrontDoorNameAvailabilityWithSubscriptionCheckResponse

Contains response data for the check operation.

FrontDoorProtocol

Defines values for FrontDoorProtocol.
KnownFrontDoorProtocol can be used interchangeably with FrontDoorProtocol, this enum contains the known values that the service supports.

Known values supported by the service

Http
Https

FrontDoorQuery

Defines values for FrontDoorQuery.
KnownFrontDoorQuery can be used interchangeably with FrontDoorQuery, this enum contains the known values that the service supports.

Known values supported by the service

StripNone
StripAll
StripOnly
StripAllExcept

FrontDoorRedirectProtocol

Defines values for FrontDoorRedirectProtocol.
KnownFrontDoorRedirectProtocol can be used interchangeably with FrontDoorRedirectProtocol, this enum contains the known values that the service supports.

Known values supported by the service

HttpOnly
HttpsOnly
MatchRequest

FrontDoorRedirectType

Defines values for FrontDoorRedirectType.
KnownFrontDoorRedirectType can be used interchangeably with FrontDoorRedirectType, this enum contains the known values that the service supports.

Known values supported by the service

Moved
Found
TemporaryRedirect
PermanentRedirect

FrontDoorResourceState

Defines values for FrontDoorResourceState.
KnownFrontDoorResourceState can be used interchangeably with FrontDoorResourceState, this enum contains the known values that the service supports.

Known values supported by the service

Creating
Enabling
Enabled
Disabling
Disabled
Deleting
Migrating
Migrated

FrontDoorTlsProtocolType

Defines values for FrontDoorTlsProtocolType.
KnownFrontDoorTlsProtocolType can be used interchangeably with FrontDoorTlsProtocolType, this enum contains the known values that the service supports.

Known values supported by the service

ServerNameIndication

FrontDoorsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

FrontDoorsGetResponse

Contains response data for the get operation.

FrontDoorsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

FrontDoorsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

FrontDoorsListNextResponse

Contains response data for the listNext operation.

FrontDoorsListResponse

Contains response data for the list operation.

FrontDoorsValidateCustomDomainResponse

Contains response data for the validateCustomDomain operation.

FrontendEndpointsGetResponse

Contains response data for the get operation.

FrontendEndpointsListByFrontDoorNextResponse

Contains response data for the listByFrontDoorNext operation.

FrontendEndpointsListByFrontDoorResponse

Contains response data for the listByFrontDoor operation.

HeaderActionType

Defines values for HeaderActionType.
KnownHeaderActionType can be used interchangeably with HeaderActionType, this enum contains the known values that the service supports.

Known values supported by the service

Append
Delete
Overwrite

HealthProbeEnabled

Defines values for HealthProbeEnabled.
KnownHealthProbeEnabled can be used interchangeably with HealthProbeEnabled, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

LatencyScorecardAggregationInterval

Defines values for LatencyScorecardAggregationInterval.
KnownLatencyScorecardAggregationInterval can be used interchangeably with LatencyScorecardAggregationInterval, this enum contains the known values that the service supports.

Known values supported by the service

Daily
Weekly
Monthly

ManagedRuleEnabledState

Defines values for ManagedRuleEnabledState.
KnownManagedRuleEnabledState can be used interchangeably with ManagedRuleEnabledState, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

ManagedRuleExclusionMatchVariable

Defines values for ManagedRuleExclusionMatchVariable.
KnownManagedRuleExclusionMatchVariable can be used interchangeably with ManagedRuleExclusionMatchVariable, this enum contains the known values that the service supports.

Known values supported by the service

RequestHeaderNames
RequestCookieNames
QueryStringArgNames
RequestBodyPostArgNames
RequestBodyJsonArgNames

ManagedRuleExclusionSelectorMatchOperator

Defines values for ManagedRuleExclusionSelectorMatchOperator.
KnownManagedRuleExclusionSelectorMatchOperator can be used interchangeably with ManagedRuleExclusionSelectorMatchOperator, this enum contains the known values that the service supports.

Known values supported by the service

Equals
Contains
StartsWith
EndsWith
EqualsAny

ManagedRuleSetActionType

Defines values for ManagedRuleSetActionType.
KnownManagedRuleSetActionType can be used interchangeably with ManagedRuleSetActionType, this enum contains the known values that the service supports.

Known values supported by the service

Block
Log
Redirect

ManagedRuleSetsListNextResponse

Contains response data for the listNext operation.

ManagedRuleSetsListResponse

Contains response data for the list operation.

MatchProcessingBehavior

Defines values for MatchProcessingBehavior.
KnownMatchProcessingBehavior can be used interchangeably with MatchProcessingBehavior, this enum contains the known values that the service supports.

Known values supported by the service

Continue
Stop

MatchVariable

Defines values for MatchVariable.
KnownMatchVariable can be used interchangeably with MatchVariable, this enum contains the known values that the service supports.

Known values supported by the service

RemoteAddr
RequestMethod
QueryString
PostArgs
RequestUri
RequestHeader
RequestBody
Cookies
SocketAddr

MinimumTLSVersion

Defines values for MinimumTLSVersion.
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.2

NetworkExperimentProfilesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

NetworkExperimentProfilesGetResponse

Contains response data for the get operation.

NetworkExperimentProfilesListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

NetworkExperimentProfilesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

NetworkExperimentProfilesListNextResponse

Contains response data for the listNext operation.

NetworkExperimentProfilesListResponse

Contains response data for the list operation.

NetworkExperimentProfilesUpdateResponse

Contains response data for the update operation.

NetworkExperimentResourceState

Defines values for NetworkExperimentResourceState.
KnownNetworkExperimentResourceState can be used interchangeably with NetworkExperimentResourceState, this enum contains the known values that the service supports.

Known values supported by the service

Creating
Enabling
Enabled
Disabling
Disabled
Deleting

NetworkOperationStatus

Defines values for NetworkOperationStatus.
KnownNetworkOperationStatus can be used interchangeably with NetworkOperationStatus, this enum contains the known values that the service supports.

Known values supported by the service

InProgress
Succeeded
Failed

Operator

Defines values for Operator.
KnownOperator can be used interchangeably with Operator, this enum contains the known values that the service supports.

Known values supported by the service

Any
IPMatch
GeoMatch
Equal
Contains
LessThan
GreaterThan
LessThanOrEqual
GreaterThanOrEqual
BeginsWith
EndsWith
RegEx

PoliciesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PoliciesGetResponse

Contains response data for the get operation.

PoliciesListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

PoliciesListBySubscriptionResponse

Contains response data for the listBySubscription operation.

PoliciesListNextResponse

Contains response data for the listNext operation.

PoliciesListResponse

Contains response data for the list operation.

PoliciesUpdateResponse

Contains response data for the update operation.

PolicyEnabledState

Defines values for PolicyEnabledState.
KnownPolicyEnabledState can be used interchangeably with PolicyEnabledState, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

PolicyMode

Defines values for PolicyMode.
KnownPolicyMode can be used interchangeably with PolicyMode, this enum contains the known values that the service supports.

Known values supported by the service

Prevention
Detection

PolicyRequestBodyCheck

Defines values for PolicyRequestBodyCheck.
KnownPolicyRequestBodyCheck can be used interchangeably with PolicyRequestBodyCheck, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

PolicyResourceState

Defines values for PolicyResourceState.
KnownPolicyResourceState can be used interchangeably with PolicyResourceState, this enum contains the known values that the service supports.

Known values supported by the service

Creating
Enabling
Enabled
Disabling
Disabled
Deleting

PreconfiguredEndpointsListNextResponse

Contains response data for the listNext operation.

PreconfiguredEndpointsListResponse

Contains response data for the list operation.

PrivateEndpointStatus

Defines values for PrivateEndpointStatus.
KnownPrivateEndpointStatus can be used interchangeably with PrivateEndpointStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected
Disconnected
Timeout

ReportsGetLatencyScorecardsResponse

Contains response data for the getLatencyScorecards operation.

ReportsGetTimeseriesResponse

Contains response data for the getTimeseries operation.

ResourceType

Defines values for ResourceType.

RouteConfigurationUnion
RoutingRuleEnabledState

Defines values for RoutingRuleEnabledState.
KnownRoutingRuleEnabledState can be used interchangeably with RoutingRuleEnabledState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

RuleType

Defines values for RuleType.
KnownRuleType can be used interchangeably with RuleType, this enum contains the known values that the service supports.

Known values supported by the service

MatchRule
RateLimitRule

RulesEngineMatchVariable

Defines values for RulesEngineMatchVariable.
KnownRulesEngineMatchVariable can be used interchangeably with RulesEngineMatchVariable, this enum contains the known values that the service supports.

Known values supported by the service

IsMobile
RemoteAddr
RequestMethod
QueryString
PostArgs
RequestUri
RequestPath
RequestFilename
RequestFilenameExtension
RequestHeader
RequestBody
RequestScheme

RulesEngineOperator

Defines values for RulesEngineOperator.
KnownRulesEngineOperator can be used interchangeably with RulesEngineOperator, this enum contains the known values that the service supports.

Known values supported by the service

Any
IPMatch
GeoMatch
Equal
Contains
LessThan
GreaterThan
LessThanOrEqual
GreaterThanOrEqual
BeginsWith
EndsWith

RulesEnginesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

RulesEnginesGetResponse

Contains response data for the get operation.

RulesEnginesListByFrontDoorNextResponse

Contains response data for the listByFrontDoorNext operation.

RulesEnginesListByFrontDoorResponse

Contains response data for the listByFrontDoor operation.

ScrubbingRuleEntryMatchOperator

Defines values for ScrubbingRuleEntryMatchOperator.
KnownScrubbingRuleEntryMatchOperator can be used interchangeably with ScrubbingRuleEntryMatchOperator, this enum contains the known values that the service supports.

Known values supported by the service

EqualsAny
Equals

ScrubbingRuleEntryMatchVariable

Defines values for ScrubbingRuleEntryMatchVariable.
KnownScrubbingRuleEntryMatchVariable can be used interchangeably with ScrubbingRuleEntryMatchVariable, this enum contains the known values that the service supports.

Known values supported by the service

RequestIPAddress
RequestUri
QueryStringArgNames
RequestHeaderNames
RequestCookieNames
RequestBodyPostArgNames
RequestBodyJsonArgNames

ScrubbingRuleEntryState

Defines values for ScrubbingRuleEntryState.
KnownScrubbingRuleEntryState can be used interchangeably with ScrubbingRuleEntryState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

SessionAffinityEnabledState

Defines values for SessionAffinityEnabledState.
KnownSessionAffinityEnabledState can be used interchangeably with SessionAffinityEnabledState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

SkuName

Defines values for SkuName.
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
Standard_AzureFrontDoor
Premium_AzureFrontDoor

State

Defines values for State.
KnownState can be used interchangeably with State, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

TimeseriesAggregationInterval

Defines values for TimeseriesAggregationInterval.
KnownTimeseriesAggregationInterval can be used interchangeably with TimeseriesAggregationInterval, this enum contains the known values that the service supports.

Known values supported by the service

Hourly
Daily

TimeseriesType

Defines values for TimeseriesType.
KnownTimeseriesType can be used interchangeably with TimeseriesType, this enum contains the known values that the service supports.

Known values supported by the service

MeasurementCounts
LatencyP50
LatencyP75
LatencyP95

Transform

Defines values for Transform.
KnownTransform can be used interchangeably with Transform, this enum contains the known values that the service supports.

Known values supported by the service

Lowercase
Uppercase
Trim
UrlDecode
UrlEncode
RemoveNulls

TransformType

Defines values for TransformType.
KnownTransformType can be used interchangeably with TransformType, this enum contains the known values that the service supports.

Known values supported by the service

Lowercase
Uppercase
Trim
UrlDecode
UrlEncode
RemoveNulls

VariableName

Defines values for VariableName.
KnownVariableName can be used interchangeably with VariableName, this enum contains the known values that the service supports.

Known values supported by the service

SocketAddr
GeoLocation
None

WebApplicationFirewallScrubbingState

Defines values for WebApplicationFirewallScrubbingState.
KnownWebApplicationFirewallScrubbingState can be used interchangeably with WebApplicationFirewallScrubbingState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

Enums

KnownActionType

Known values of ActionType that the service accepts.

KnownAggregationInterval

Known values of AggregationInterval that the service accepts.

KnownAvailability

Known values of Availability that the service accepts.

KnownBackendEnabledState

Known values of BackendEnabledState that the service accepts.

KnownCustomHttpsProvisioningState

Known values of CustomHttpsProvisioningState that the service accepts.

KnownCustomHttpsProvisioningSubstate

Known values of CustomHttpsProvisioningSubstate that the service accepts.

KnownCustomRuleEnabledState

Known values of CustomRuleEnabledState that the service accepts.

KnownDynamicCompressionEnabled

Known values of DynamicCompressionEnabled that the service accepts.

KnownEndpointType

Known values of EndpointType that the service accepts.

KnownEnforceCertificateNameCheckEnabledState

Known values of EnforceCertificateNameCheckEnabledState that the service accepts.

KnownFrontDoorCertificateSource

Known values of FrontDoorCertificateSource that the service accepts.

KnownFrontDoorCertificateType

Known values of FrontDoorCertificateType that the service accepts.

KnownFrontDoorEnabledState

Known values of FrontDoorEnabledState that the service accepts.

KnownFrontDoorForwardingProtocol

Known values of FrontDoorForwardingProtocol that the service accepts.

KnownFrontDoorHealthProbeMethod

Known values of FrontDoorHealthProbeMethod that the service accepts.

KnownFrontDoorProtocol

Known values of FrontDoorProtocol that the service accepts.

KnownFrontDoorQuery

Known values of FrontDoorQuery that the service accepts.

KnownFrontDoorRedirectProtocol

Known values of FrontDoorRedirectProtocol that the service accepts.

KnownFrontDoorRedirectType

Known values of FrontDoorRedirectType that the service accepts.

KnownFrontDoorResourceState

Known values of FrontDoorResourceState that the service accepts.

KnownFrontDoorTlsProtocolType

Known values of FrontDoorTlsProtocolType that the service accepts.

KnownHeaderActionType

Known values of HeaderActionType that the service accepts.

KnownHealthProbeEnabled

Known values of HealthProbeEnabled that the service accepts.

KnownLatencyScorecardAggregationInterval

Known values of LatencyScorecardAggregationInterval that the service accepts.

KnownManagedRuleEnabledState

Known values of ManagedRuleEnabledState that the service accepts.

KnownManagedRuleExclusionMatchVariable

Known values of ManagedRuleExclusionMatchVariable that the service accepts.

KnownManagedRuleExclusionSelectorMatchOperator

Known values of ManagedRuleExclusionSelectorMatchOperator that the service accepts.

KnownManagedRuleSetActionType

Known values of ManagedRuleSetActionType that the service accepts.

KnownMatchProcessingBehavior

Known values of MatchProcessingBehavior that the service accepts.

KnownMatchVariable

Known values of MatchVariable that the service accepts.

KnownMinimumTLSVersion

Known values of MinimumTLSVersion that the service accepts.

KnownNetworkExperimentResourceState

Known values of NetworkExperimentResourceState that the service accepts.

KnownNetworkOperationStatus

Known values of NetworkOperationStatus that the service accepts.

KnownOperator

Known values of Operator that the service accepts.

KnownPolicyEnabledState

Known values of PolicyEnabledState that the service accepts.

KnownPolicyMode

Known values of PolicyMode that the service accepts.

KnownPolicyRequestBodyCheck

Known values of PolicyRequestBodyCheck that the service accepts.

KnownPolicyResourceState

Known values of PolicyResourceState that the service accepts.

KnownPrivateEndpointStatus

Known values of PrivateEndpointStatus that the service accepts.

KnownRoutingRuleEnabledState

Known values of RoutingRuleEnabledState that the service accepts.

KnownRuleType

Known values of RuleType that the service accepts.

KnownRulesEngineMatchVariable

Known values of RulesEngineMatchVariable that the service accepts.

KnownRulesEngineOperator

Known values of RulesEngineOperator that the service accepts.

KnownScrubbingRuleEntryMatchOperator

Known values of ScrubbingRuleEntryMatchOperator that the service accepts.

KnownScrubbingRuleEntryMatchVariable

Known values of ScrubbingRuleEntryMatchVariable that the service accepts.

KnownScrubbingRuleEntryState

Known values of ScrubbingRuleEntryState that the service accepts.

KnownSessionAffinityEnabledState

Known values of SessionAffinityEnabledState that the service accepts.

KnownSkuName

Known values of SkuName that the service accepts.

KnownState

Known values of State that the service accepts.

KnownTimeseriesAggregationInterval

Known values of TimeseriesAggregationInterval that the service accepts.

KnownTimeseriesType

Known values of TimeseriesType that the service accepts.

KnownTransform

Known values of Transform that the service accepts.

KnownTransformType

Known values of TransformType that the service accepts.

KnownVariableName

Known values of VariableName that the service accepts.

KnownWebApplicationFirewallScrubbingState

Known values of WebApplicationFirewallScrubbingState that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.