@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. Known values supported by the serviceAllow |
AggregationInterval |
Defines values for AggregationInterval. Known values supported by the serviceHourly |
Availability |
Defines values for Availability. Known values supported by the serviceAvailable |
BackendEnabledState |
Defines values for BackendEnabledState. Known values supported by the serviceEnabled |
CustomHttpsProvisioningState |
Defines values for CustomHttpsProvisioningState. Known values supported by the serviceEnabling |
CustomHttpsProvisioningSubstate |
Defines values for CustomHttpsProvisioningSubstate. Known values supported by the serviceSubmittingDomainControlValidationRequest |
CustomRuleEnabledState |
Defines values for CustomRuleEnabledState. Known values supported by the serviceDisabled |
DynamicCompressionEnabled |
Defines values for DynamicCompressionEnabled. Known values supported by the serviceEnabled |
EndpointType |
Defines values for EndpointType. Known values supported by the serviceAFD |
EnforceCertificateNameCheckEnabledState |
Defines values for EnforceCertificateNameCheckEnabledState. Known values supported by the serviceEnabled |
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. Known values supported by the serviceAzureKeyVault |
FrontDoorCertificateType |
Defines values for FrontDoorCertificateType. Known values supported by the serviceDedicated |
FrontDoorEnabledState |
Defines values for FrontDoorEnabledState. Known values supported by the serviceEnabled |
FrontDoorForwardingProtocol |
Defines values for FrontDoorForwardingProtocol. Known values supported by the serviceHttpOnly |
FrontDoorHealthProbeMethod |
Defines values for FrontDoorHealthProbeMethod. Known values supported by the serviceGET |
FrontDoorNameAvailabilityCheckResponse |
Contains response data for the check operation. |
FrontDoorNameAvailabilityWithSubscriptionCheckResponse |
Contains response data for the check operation. |
FrontDoorProtocol |
Defines values for FrontDoorProtocol. Known values supported by the serviceHttp |
FrontDoorQuery |
Defines values for FrontDoorQuery. Known values supported by the serviceStripNone |
FrontDoorRedirectProtocol |
Defines values for FrontDoorRedirectProtocol. Known values supported by the serviceHttpOnly |
FrontDoorRedirectType |
Defines values for FrontDoorRedirectType. Known values supported by the serviceMoved |
FrontDoorResourceState |
Defines values for FrontDoorResourceState. Known values supported by the serviceCreating |
FrontDoorTlsProtocolType |
Defines values for FrontDoorTlsProtocolType. Known values supported by the serviceServerNameIndication |
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. Known values supported by the serviceAppend |
HealthProbeEnabled |
Defines values for HealthProbeEnabled. Known values supported by the serviceEnabled |
LatencyScorecardAggregationInterval |
Defines values for LatencyScorecardAggregationInterval. Known values supported by the serviceDaily |
ManagedRuleEnabledState |
Defines values for ManagedRuleEnabledState. Known values supported by the serviceDisabled |
ManagedRuleExclusionMatchVariable |
Defines values for ManagedRuleExclusionMatchVariable. Known values supported by the serviceRequestHeaderNames |
ManagedRuleExclusionSelectorMatchOperator |
Defines values for ManagedRuleExclusionSelectorMatchOperator. Known values supported by the serviceEquals |
ManagedRuleSetActionType |
Defines values for ManagedRuleSetActionType. Known values supported by the serviceBlock |
ManagedRuleSetsListNextResponse |
Contains response data for the listNext operation. |
ManagedRuleSetsListResponse |
Contains response data for the list operation. |
MatchProcessingBehavior |
Defines values for MatchProcessingBehavior. Known values supported by the serviceContinue |
MatchVariable |
Defines values for MatchVariable. Known values supported by the serviceRemoteAddr |
MinimumTLSVersion |
Defines values for MinimumTLSVersion. Known values supported by the service1.0 |
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. Known values supported by the serviceCreating |
NetworkOperationStatus |
Defines values for NetworkOperationStatus. Known values supported by the serviceInProgress |
Operator |
Defines values for Operator. Known values supported by the serviceAny |
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. Known values supported by the serviceDisabled |
PolicyMode |
Defines values for PolicyMode. Known values supported by the servicePrevention |
PolicyRequestBodyCheck |
Defines values for PolicyRequestBodyCheck. Known values supported by the serviceDisabled |
PolicyResourceState |
Defines values for PolicyResourceState. Known values supported by the serviceCreating |
PreconfiguredEndpointsListNextResponse |
Contains response data for the listNext operation. |
PreconfiguredEndpointsListResponse |
Contains response data for the list operation. |
PrivateEndpointStatus |
Defines values for PrivateEndpointStatus. Known values supported by the servicePending |
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. Known values supported by the serviceEnabled |
RuleType |
Defines values for RuleType. Known values supported by the serviceMatchRule |
RulesEngineMatchVariable |
Defines values for RulesEngineMatchVariable. Known values supported by the serviceIsMobile |
RulesEngineOperator |
Defines values for RulesEngineOperator. Known values supported by the serviceAny |
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. Known values supported by the serviceEqualsAny |
ScrubbingRuleEntryMatchVariable |
Defines values for ScrubbingRuleEntryMatchVariable. Known values supported by the serviceRequestIPAddress |
ScrubbingRuleEntryState |
Defines values for ScrubbingRuleEntryState. Known values supported by the serviceEnabled |
SessionAffinityEnabledState |
Defines values for SessionAffinityEnabledState. Known values supported by the serviceEnabled |
SkuName |
Defines values for SkuName. Known values supported by the serviceClassic_AzureFrontDoor |
State |
Defines values for State. Known values supported by the serviceEnabled |
TimeseriesAggregationInterval |
Defines values for TimeseriesAggregationInterval. Known values supported by the serviceHourly |
TimeseriesType |
Defines values for TimeseriesType. Known values supported by the serviceMeasurementCounts |
Transform |
Defines values for Transform. Known values supported by the serviceLowercase |
TransformType |
Defines values for TransformType. Known values supported by the serviceLowercase |
VariableName |
Defines values for VariableName. Known values supported by the serviceSocketAddr |
WebApplicationFirewallScrubbingState |
Defines values for WebApplicationFirewallScrubbingState. Known values supported by the serviceEnabled |
Enums
Functions
get |
Given the last |
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.