models Package

Classes

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.

Variables are only populated by the server, and will be ignored when sending a request.

BackendPool

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

Variables are only populated by the server, and will be ignored when sending a request.

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.

Variables are only populated by the server, and will be ignored when sending a request.

BackendPoolProperties

The JSON object that contains the properties required to create a Backend Pool.

Variables are only populated by the server, and will be ignored when sending a request.

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.

All required parameters must be populated in order to send to Azure.

CheckNameAvailabilityOutput

Output of check name availability API.

Variables are only populated by the server, and will be ignored when sending a request.

CustomHttpsConfiguration

Https settings for a domain.

All required parameters must be populated in order to send to Azure.

CustomRule

Defines contents of a web application rule.

All required parameters must be populated in order to send to Azure.

CustomRuleList

Defines contents of custom rules.

Endpoint

Defines the endpoint properties.

Error

Error.

ErrorDetails

ErrorDetails.

ErrorResponse

Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.

Variables are only populated by the server, and will be ignored when sending a request.

Experiment

Defines the properties of an Experiment.

Variables are only populated by the server, and will be ignored when sending a request.

ExperimentList

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

Variables are only populated by the server, and will be ignored when sending a request.

ExperimentUpdateModel

Defines modifiable attributes of an Experiment.

ForwardingConfiguration

Describes Forwarding Route.

All required parameters must be populated in order to send to Azure.

FrontDoor

Front Door represents a collection of backend endpoints to route traffic to along with rules that specify how traffic is sent there.

Variables are only populated by the server, and will be ignored when sending a request.

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.

Variables are only populated by the server, and will be ignored when sending a request.

FrontDoorProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

FrontDoorUpdateParameters

The properties needed to update a Front Door.

FrontendEndpoint

A frontend endpoint used for routing.

Variables are only populated by the server, and will be ignored when sending a request.

FrontendEndpointLink

Defines the Resource ID for a Frontend Endpoint.

FrontendEndpointProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

FrontendEndpointUpdateParameters

Frontend endpoint used in routing rule.

FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink

Defines the Web Application Firewall policy for each host (if applicable).

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.

Variables are only populated by the server, and will be ignored when sending a request.

HeaderAction

An action that can manipulate an http header.

All required parameters must be populated in order to send to Azure.

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.

Variables are only populated by the server, and will be ignored when sending a request.

HealthProbeSettingsModel

Load balancing settings for a backend pool.

Variables are only populated by the server, and will be ignored when sending a request.

HealthProbeSettingsProperties

The JSON object that contains the properties required to create a health probe settings.

Variables are only populated by the server, and will be ignored when sending a request.

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.

Variables are only populated by the server, and will be ignored when sending a request.

LatencyScorecard

Defines the LatencyScorecard.

Variables are only populated by the server, and will be ignored when sending a request.

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.

Variables are only populated by the server, and will be ignored when sending a request.

LoadBalancingSettingsModel

Load balancing settings for a backend pool.

Variables are only populated by the server, and will be ignored when sending a request.

LoadBalancingSettingsProperties

The JSON object that contains the properties required to create load balancing settings.

Variables are only populated by the server, and will be ignored when sending a request.

LoadBalancingSettingsUpdateParameters

Round-Robin load balancing settings for a backend pool.

ManagedRuleDefinition

Describes a managed rule definition.

Variables are only populated by the server, and will be ignored when sending a request.

ManagedRuleExclusion

Exclude variables from managed rule evaluation.

All required parameters must be populated in order to send to Azure.

ManagedRuleGroupDefinition

Describes a managed rule group.

Variables are only populated by the server, and will be ignored when sending a request.

ManagedRuleGroupOverride

Defines a managed rule group override setting.

All required parameters must be populated in order to send to Azure.

ManagedRuleOverride

Defines a managed rule group override setting.

All required parameters must be populated in order to send to Azure.

ManagedRuleSet

Defines a managed rule set.

All required parameters must be populated in order to send to Azure.

ManagedRuleSetDefinition

Describes the a managed rule set definition.

Variables are only populated by the server, and will be ignored when sending a request.

ManagedRuleSetDefinitionList

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

Variables are only populated by the server, and will be ignored when sending a request.

ManagedRuleSetList

Defines the list of managed rule sets for the policy.

MatchCondition

Define a match condition.

All required parameters must be populated in order to send to Azure.

PolicySettings

Defines top-level WebApplicationFirewallPolicy configuration settings.

PreconfiguredEndpoint

Defines the properties of a preconfigured endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

PreconfiguredEndpointList

Defines a list of preconfigured endpoints.

Variables are only populated by the server, and will be ignored when sending a request.

Profile

Defines an Network Experiment Profile and lists of Experiments.

Variables are only populated by the server, and will be ignored when sending a request.

ProfileList

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

Variables are only populated by the server, and will be ignored when sending a request.

ProfileUpdateModel

Defines modifiable attributes of a Profile.

PurgeParameters

Parameters required for content purge.

All required parameters must be populated in order to send to Azure.

RedirectConfiguration

Describes Redirect Route.

All required parameters must be populated in order to send to Azure.

Resource

Common resource representation.

Variables are only populated by the server, and will be ignored when sending a request.

RouteConfiguration

Base class for all types of Route.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ForwardingConfiguration, RedirectConfiguration.

All required parameters must be populated in order to send to Azure.

RoutingRule

A routing rule represents a specification for traffic to treat and where to send it, along with health probe information.

Variables are only populated by the server, and will be ignored when sending a request.

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.

Variables are only populated by the server, and will be ignored when sending a request.

RoutingRuleProperties

The JSON object that contains the properties required to create a routing rule.

Variables are only populated by the server, and will be ignored when sending a request.

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.

Variables are only populated by the server, and will be ignored when sending a request.

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.

Variables are only populated by the server, and will be ignored when sending a request.

RulesEngineMatchCondition

Define a match condition.

All required parameters must be populated in order to send to Azure.

RulesEngineProperties

The JSON object that contains the properties required to create a Rules Engine Configuration.

Variables are only populated by the server, and will be ignored when sending a request.

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.

All required parameters must be populated in order to send to Azure.

RulesEngineUpdateParameters

Rules Engine Configuration to apply to a Routing Rule.

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.

Variables are only populated by the server, and will be ignored when sending a request.

TimeseriesDataPoint

Defines a timeseries datapoint used in a timeseries.

ValidateCustomDomainInput

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

All required parameters must be populated in order to send to Azure.

ValidateCustomDomainOutput

Output of custom domain validation.

Variables are only populated by the server, and will be ignored when sending a request.

WebApplicationFirewallPolicy

Defines web application firewall policy.

Variables are only populated by the server, and will be ignored when sending a request.

WebApplicationFirewallPolicyList

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

Variables are only populated by the server, and will be ignored when sending a request.

Enums

ActionType

Defines the action to take on rule match.

AggregationInterval

The aggregation interval of the Timeseries

Availability

Indicates whether the name is available.

BackendEnabledState

Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'

CustomHttpsProvisioningState

Provisioning status of Custom Https of the frontendEndpoint.

CustomHttpsProvisioningSubstate

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

CustomRuleEnabledState

Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.

DynamicCompressionEnabled

Whether to use dynamic compression for cached content

EndpointType

The type of endpoint

EnforceCertificateNameCheckEnabledState

Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests.

FrontDoorCertificateSource

Defines the source of the SSL certificate

FrontDoorCertificateType

Defines the type of the certificate used for secure connections to a frontendEndpoint

FrontDoorEnabledState

Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'

FrontDoorForwardingProtocol

Protocol this rule will use when forwarding traffic to backends.

FrontDoorHealthProbeMethod

Configures which HTTP method to use to probe the backends defined under backendPools.

FrontDoorProtocol

Accepted protocol schemes.

FrontDoorQuery

Treatment of URL query terms when forming the cache key.

FrontDoorRedirectProtocol

The protocol of the destination to where the traffic is redirected

FrontDoorRedirectType

The redirect type the rule will use when redirecting traffic.

FrontDoorResourceState

Resource status of the Front Door or Front Door SubResource.

FrontDoorTlsProtocolType

Defines the TLS extension protocol that is used for secure delivery

HeaderActionType

Which type of manipulation to apply to the header.

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.

LatencyScorecardAggregationInterval

An enumeration.

ManagedRuleEnabledState

Describes if the managed rule is in enabled or disabled state.

ManagedRuleExclusionMatchVariable

The variable type to be excluded.

ManagedRuleExclusionSelectorMatchOperator

Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to.

ManagedRuleSetActionType

Defines the action to take when a managed rule set score threshold is met.

MatchProcessingBehavior

If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.

MatchVariable

Request variable to compare with.

MinimumTLSVersion

The minimum TLS version required from the clients to establish an SSL handshake with Front Door.

NetworkExperimentResourceState

Defines the server side resource status

NetworkOperationStatus

Status of the Azure async operation.

Operator

Comparison type to use for matching with the variable value.

PolicyEnabledState

Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified.

PolicyMode

Describes if it is in detection mode or prevention mode at policy level.

PolicyRequestBodyCheck

Describes if policy managed rules will inspect the request body content.

PolicyResourceState

Resource status of the policy.

PrivateEndpointStatus

The Approval status for the connection to the Private Link

ResourceType

Type of Front Door resource used in CheckNameAvailability.

RoutingRuleEnabledState

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'

RuleType

Describes type of rule.

RulesEngineMatchVariable

Match Variable

RulesEngineOperator

Describes operator to apply to the match condition.

SessionAffinityEnabledState

Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'

SkuName

Name of the pricing tier.

State

The state of the Experiment

TimeseriesAggregationInterval

An enumeration.

TimeseriesType

The type of Timeseries

Transform

Describes what transforms are applied before matching

TransformType

Describes what transforms applied before matching.