Package-level declarations

Types

Link copied to clipboard
data class BackendPoolResponse(val backends: List<BackendResponse>? = null, val healthProbeSettings: SubResourceResponse? = null, val id: String? = null, val loadBalancingSettings: SubResourceResponse? = null, val name: String? = null, val resourceState: String, val type: String)

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

Link copied to clipboard
data class BackendPoolsSettingsResponse(val enforceCertificateNameCheck: String? = null, val sendRecvTimeoutSeconds: Int? = null)

Settings that apply to all backend pools.

Link copied to clipboard
data class BackendResponse(val address: String? = null, val backendHostHeader: String? = null, val enabledState: String? = null, val httpPort: Int? = null, val httpsPort: Int? = null, val priority: Int? = null, val privateEndpointStatus: String, val privateLinkAlias: String? = null, val privateLinkApprovalMessage: String? = null, val privateLinkLocation: String? = null, val privateLinkResourceId: String? = null, val weight: Int? = null)

Backend address of a frontDoor load balancer.

Link copied to clipboard
data class CacheConfigurationResponse(val cacheDuration: String? = null, val dynamicCompression: String? = null, val queryParameterStripDirective: String? = null, val queryParameters: String? = null)

Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.

Link copied to clipboard
data class CustomHttpsConfigurationResponse(val certificateSource: String, val certificateType: String? = null, val minimumTlsVersion: String, val protocolType: String, val secretName: String? = null, val secretVersion: String? = null, val vault: KeyVaultCertificateSourceParametersResponseVault? = null)

Https settings for a domain

Link copied to clipboard
data class CustomRuleListResponse(val rules: List<CustomRuleResponse>? = null)

Defines contents of custom rules

Link copied to clipboard
data class CustomRuleResponse(val action: String, val enabledState: String? = null, val groupBy: List<GroupByVariableResponse>? = null, val matchConditions: List<MatchConditionResponse>, val name: String? = null, val priority: Int, val rateLimitDurationInMinutes: Int? = null, val rateLimitThreshold: Int? = null, val ruleType: String)

Defines contents of a web application rule

Link copied to clipboard
data class EndpointResponse(val endpoint: String? = null, val name: String? = null)

Defines the endpoint properties

Link copied to clipboard
data class ForwardingConfigurationResponse(val backendPool: SubResourceResponse? = null, val cacheConfiguration: CacheConfigurationResponse? = null, val customForwardingPath: String? = null, val forwardingProtocol: String? = null, val odataType: String)

Describes Forwarding Route.

Link copied to clipboard
data class FrontendEndpointLinkResponse(val id: String? = null)

Defines the Resource ID for a Frontend Endpoint.

Link copied to clipboard
data class FrontendEndpointResponse(val customHttpsConfiguration: CustomHttpsConfigurationResponse, val customHttpsProvisioningState: String, val customHttpsProvisioningSubstate: String, val hostName: String? = null, val id: String? = null, val name: String? = null, val resourceState: String, val sessionAffinityEnabledState: String? = null, val sessionAffinityTtlSeconds: Int? = null, val type: String, val webApplicationFirewallPolicyLink: FrontendEndpointUpdateParametersResponseWebApplicationFirewallPolicyLink? = null)

A frontend endpoint used for routing.

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

Link copied to clipboard
data class GetExperimentResult(val azureApiVersion: String, val description: String? = null, val enabledState: String? = null, val endpointA: EndpointResponse? = null, val endpointB: EndpointResponse? = null, val id: String, val location: String? = null, val name: String, val resourceState: String, val scriptFileUri: String, val status: String, val tags: Map<String, String>? = null, val type: String)

Defines the properties of an Experiment

Link copied to clipboard
data class GetFrontDoorResult(val azureApiVersion: String, val backendPools: List<BackendPoolResponse>? = null, val backendPoolsSettings: BackendPoolsSettingsResponse? = null, val cname: String, val enabledState: String? = null, val extendedProperties: Map<String, String>, val friendlyName: String? = null, val frontdoorId: String, val frontendEndpoints: List<FrontendEndpointResponse>? = null, val healthProbeSettings: List<HealthProbeSettingsModelResponse>? = null, val id: String, val loadBalancingSettings: List<LoadBalancingSettingsModelResponse>? = null, val location: String? = null, val name: String, val provisioningState: String, val resourceState: String, val routingRules: List<RoutingRuleResponse>? = null, val rulesEngines: List<RulesEngineResponse>, val tags: Map<String, String>? = null, val type: String)

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

Link copied to clipboard
data class GetNetworkExperimentProfileResult(val azureApiVersion: String, val enabledState: String? = null, val etag: String? = null, val id: String, val location: String? = null, val name: String, val resourceState: String, val tags: Map<String, String>? = null, val type: String)

Defines an Network Experiment Profile and lists of Experiments

Link copied to clipboard
data class GetPolicyResult(val azureApiVersion: String, val customRules: CustomRuleListResponse? = null, val etag: String? = null, val frontendEndpointLinks: List<FrontendEndpointLinkResponse>, val id: String, val location: String? = null, val managedRules: ManagedRuleSetListResponse? = null, val name: String, val policySettings: PolicySettingsResponse? = null, val provisioningState: String, val resourceState: String, val routingRuleLinks: List<RoutingRuleLinkResponse>, val securityPolicyLinks: List<SecurityPolicyLinkResponse>, val sku: SkuResponse? = null, val tags: Map<String, String>? = null, val type: String)

Defines web application firewall policy.

Link copied to clipboard
data class GetRulesEngineResult(val azureApiVersion: String, val id: String, val name: String, val resourceState: String, val rules: List<RulesEngineRuleResponse>? = null, val type: String)

A rules engine configuration containing a list of rules that will run to modify the runtime behavior of the request and response.

Link copied to clipboard
data class GroupByVariableResponse(val variableName: String)

Describes the variables available to group the rate limit requests

Link copied to clipboard
data class HeaderActionResponse(val headerActionType: String, val headerName: String, val value: String? = null)

An action that can manipulate an http header.

Link copied to clipboard
data class HealthProbeSettingsModelResponse(val enabledState: String? = null, val healthProbeMethod: String? = null, val id: String? = null, val intervalInSeconds: Int? = null, val name: String? = null, val path: String? = null, val protocol: String? = null, val resourceState: String, val type: String)

Load balancing settings for a backend pool

The Key Vault containing the SSL certificate

Link copied to clipboard
data class LoadBalancingSettingsModelResponse(val additionalLatencyMilliseconds: Int? = null, val id: String? = null, val name: String? = null, val resourceState: String, val sampleSize: Int? = null, val successfulSamplesRequired: Int? = null, val type: String)

Load balancing settings for a backend pool

Link copied to clipboard
data class ManagedRuleExclusionResponse(val matchVariable: String, val selector: String, val selectorMatchOperator: String)

Exclude variables from managed rule evaluation.

Link copied to clipboard
data class ManagedRuleGroupOverrideResponse(val exclusions: List<ManagedRuleExclusionResponse>? = null, val ruleGroupName: String, val rules: List<ManagedRuleOverrideResponse>? = null)

Defines a managed rule group override setting.

Link copied to clipboard
data class ManagedRuleOverrideResponse(val action: String? = null, val enabledState: String? = null, val exclusions: List<ManagedRuleExclusionResponse>? = null, val ruleId: String)

Defines a managed rule group override setting.

Link copied to clipboard
data class ManagedRuleSetListResponse(val managedRuleSets: List<ManagedRuleSetResponse>? = null)

Defines the list of managed rule sets for the policy.

Link copied to clipboard
data class ManagedRuleSetResponse(val exclusions: List<ManagedRuleExclusionResponse>? = null, val ruleGroupOverrides: List<ManagedRuleGroupOverrideResponse>? = null, val ruleSetAction: String? = null, val ruleSetType: String, val ruleSetVersion: String)

Defines a managed rule set.

Link copied to clipboard
data class MatchConditionResponse(val matchValue: List<String>, val matchVariable: String, val negateCondition: Boolean? = null, val operator: String, val selector: String? = null, val transforms: List<String>? = null)

Define a match condition.

Link copied to clipboard
data class PolicySettingsResponse(val customBlockResponseBody: String? = null, val customBlockResponseStatusCode: Int? = null, val enabledState: String? = null, val javascriptChallengeExpirationInMinutes: Int? = null, val mode: String? = null, val redirectUrl: String? = null, val requestBodyCheck: String? = null, val scrubbingRules: List<WebApplicationFirewallScrubbingRulesResponse>? = null, val state: String? = null)

Defines top-level WebApplicationFirewallPolicy configuration settings.

Link copied to clipboard
data class RedirectConfigurationResponse(val customFragment: String? = null, val customHost: String? = null, val customPath: String? = null, val customQueryString: String? = null, val odataType: String, val redirectProtocol: String? = null, val redirectType: String? = null)

Describes Redirect Route.

Link copied to clipboard
data class RoutingRuleLinkResponse(val id: String? = null)

Defines the Resource ID for a Routing Rule.

Link copied to clipboard
data class RoutingRuleResponse(val acceptedProtocols: List<String>? = null, val enabledState: String? = null, val frontendEndpoints: List<SubResourceResponse>? = null, val id: String? = null, val name: String? = null, val patternsToMatch: List<String>? = null, val resourceState: String, val routeConfiguration: Either<ForwardingConfigurationResponse, RedirectConfigurationResponse>? = null, val rulesEngine: SubResourceResponse? = null, val type: String, val webApplicationFirewallPolicyLink: RoutingRuleUpdateParametersResponseWebApplicationFirewallPolicyLink? = null)

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

Defines the Web Application Firewall policy for each routing rule (if applicable)

Link copied to clipboard
data class RulesEngineActionResponse(val requestHeaderActions: List<HeaderActionResponse>? = null, val responseHeaderActions: List<HeaderActionResponse>? = null, val routeConfigurationOverride: Either<ForwardingConfigurationResponse, RedirectConfigurationResponse>? = null)

One or more actions that will execute, modifying the request and/or response.

Link copied to clipboard
data class RulesEngineMatchConditionResponse(val negateCondition: Boolean? = null, val rulesEngineMatchValue: List<String>, val rulesEngineMatchVariable: String, val rulesEngineOperator: String, val selector: String? = null, val transforms: List<String>? = null)

Define a match condition

Link copied to clipboard
data class RulesEngineResponse(val id: String, val name: String, val resourceState: String, val rules: List<RulesEngineRuleResponse>? = null, val type: String)

A rules engine configuration containing a list of rules that will run to modify the runtime behavior of the request and response.

Link copied to clipboard
data class RulesEngineRuleResponse(val action: RulesEngineActionResponse, val matchConditions: List<RulesEngineMatchConditionResponse>? = null, val matchProcessingBehavior: String? = null, val name: String, val priority: Int)

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.

Link copied to clipboard
data class SecurityPolicyLinkResponse(val id: String? = null)

Defines the Resource ID for a Security Policy.

Link copied to clipboard
data class SkuResponse(val name: String? = null)

The pricing tier of the web application firewall policy.

Link copied to clipboard
data class SubResourceResponse(val id: String? = null)

Reference to another subresource.

data class WebApplicationFirewallScrubbingRulesResponse(val matchVariable: String, val selector: String? = null, val selectorMatchOperator: String, val state: String? = null)

Defines the contents of the log scrubbing rules.