azure.mgmt.frontdoor.models module

exception azure.mgmt.frontdoor.models.ErrorResponseException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorResponse’.

Parameters

  • deserialize – A deserializer

  • response – Server response to be deserialized.

class azure.mgmt.frontdoor.models.AzureAsyncOperationResult(*, status=None, error=None, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters

  • status (str or NetworkOperationStatus) – Status of the Azure async operation. Possible values are: ‘InProgress’, ‘Succeeded’, and ‘Failed’. Possible values include: ‘InProgress’, ‘Succeeded’, ‘Failed’

  • error (Error) –

class azure.mgmt.frontdoor.models.Backend(*, address: str = None, http_port: int = None, https_port: int = None, enabled_state=None, priority: int = None, weight: int = None, backend_host_header: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Backend address of a frontDoor load balancer.

Parameters

  • address (str) – Location of the backend (IP address or FQDN)

  • http_port (int) – The HTTP TCP port number. Must be between 1 and 65535.

  • https_port (int) – The HTTPS TCP port number. Must be between 1 and 65535.

  • enabled_state (str or BackendEnabledState) – Whether to enable use of this backend. Permitted values are ‘Enabled’ or ‘Disabled’. Possible values include: ‘Enabled’, ‘Disabled’

  • priority (int) – Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.

  • weight (int) – Weight of this endpoint for load balancing purposes.

  • backend_host_header (str) – The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host.

class azure.mgmt.frontdoor.models.BackendPool(*, id: str = None, backends=None, load_balancing_settings=None, health_probe_settings=None, resource_state=None, name: str = None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.SubResource

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.

Parameters

  • id (str) – Resource ID.

  • backends (list[Backend]) – The set of backends for this pool

  • load_balancing_settings (SubResource) – Load balancing settings for a backend pool

  • health_probe_settings (SubResource) – L7 health probe settings for a backend pool

  • resource_state (str or FrontDoorResourceState) – Resource status. Possible values include: ‘Creating’, ‘Enabling’, ‘Enabled’, ‘Disabling’, ‘Disabled’, ‘Deleting’

  • name (str) – Resource name.

Variables

type (str) – Resource type.

class azure.mgmt.frontdoor.models.BackendPoolListResult(*, next_link: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Variables

value (list[BackendPool]) – List of Backend Pools within a Front Door.

Parameters

next_link (str) – URL to get the next set of BackendPool objects if there are any.

class azure.mgmt.frontdoor.models.BackendPoolsSettings(*, enforce_certificate_name_check='Enabled', send_recv_timeout_seconds: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Settings that apply to all backend pools.

Parameters

  • enforce_certificate_name_check (str or EnforceCertificateNameCheckEnabledState) – Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. Possible values include: ‘Enabled’, ‘Disabled’. Default value: “Enabled” .

  • send_recv_timeout_seconds (int) – Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns.

class azure.mgmt.frontdoor.models.BackendPoolUpdateParameters(*, backends=None, load_balancing_settings=None, health_probe_settings=None, **kwargs)[source]

Bases: msrest.serialization.Model

A collection of backends that can be routed to.

Parameters

  • backends (list[Backend]) – The set of backends for this pool

  • load_balancing_settings (SubResource) – Load balancing settings for a backend pool

  • health_probe_settings (SubResource) – L7 health probe settings for a backend pool

class azure.mgmt.frontdoor.models.CacheConfiguration(*, query_parameter_strip_directive=None, dynamic_compression=None, **kwargs)[source]

Bases: msrest.serialization.Model

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

Parameters

  • query_parameter_strip_directive (str or FrontDoorQuery) – Treatment of URL query terms when forming the cache key. Possible values include: ‘StripNone’, ‘StripAll’

  • dynamic_compression (str or DynamicCompressionEnabled) – Whether to use dynamic compression for cached content. Possible values include: ‘Enabled’, ‘Disabled’

class azure.mgmt.frontdoor.models.CheckNameAvailabilityInput(*, name: str, type, **kwargs)[source]

Bases: msrest.serialization.Model

Input of CheckNameAvailability API.

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

Parameters

  • name (str) – Required. The resource name to validate.

  • type (str or ResourceType) – Required. The type of the resource whose name is to be validated. Possible values include: ‘Microsoft.Network/frontDoors’, ‘Microsoft.Network/frontDoors/frontendEndpoints’

class azure.mgmt.frontdoor.models.CheckNameAvailabilityOutput(**kwargs)[source]

Bases: msrest.serialization.Model

Output of check name availability API.

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

Variables

  • name_availability (str or Availability) – Indicates whether the name is available. Possible values include: ‘Available’, ‘Unavailable’

  • reason (str) – The reason why the name is not available.

  • message (str) – The detailed error message describing why the name is not available.

class azure.mgmt.frontdoor.models.CustomHttpsConfiguration(*, certificate_source, minimum_tls_version, vault=None, secret_name: str = None, secret_version: str = None, certificate_type=None, **kwargs)[source]

Bases: msrest.serialization.Model

Https settings for a domain.

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

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

Parameters

  • certificate_source (str or FrontDoorCertificateSource) – Required. Defines the source of the SSL certificate. Possible values include: ‘AzureKeyVault’, ‘FrontDoor’

  • minimum_tls_version (str or MinimumTLSVersion) – Required. The minimum TLS version required from the clients to establish an SSL handshake with Front Door. Possible values include: ‘1.0’, ‘1.2’

  • vault (KeyVaultCertificateSourceParametersVault) – The Key Vault containing the SSL certificate

  • secret_name (str) – The name of the Key Vault secret representing the full certificate PFX

  • secret_version (str) – The version of the Key Vault secret representing the full certificate PFX

  • certificate_type (str or FrontDoorCertificateType) – Defines the type of the certificate used for secure connections to a frontendEndpoint. Possible values include: ‘Dedicated’

Variables

protocol_type (str) – Required. Defines the TLS extension protocol that is used for secure delivery. Default value: “ServerNameIndication” .

protocol_type = 'ServerNameIndication'
class azure.mgmt.frontdoor.models.CustomRule(*, priority: int, rule_type, match_conditions, action, name: str = None, enabled_state=None, rate_limit_duration_in_minutes: int = None, rate_limit_threshold: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Defines contents of a web application rule.

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

Parameters

  • name (str) – Describes the name of the rule.

  • priority (int) – Required. Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.

  • enabled_state (str or CustomRuleEnabledState) – Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. Possible values include: ‘Disabled’, ‘Enabled’

  • rule_type (str or RuleType) – Required. Describes type of rule. Possible values include: ‘MatchRule’, ‘RateLimitRule’

  • rate_limit_duration_in_minutes (int) – Time window for resetting the rate limit count. Default is 1 minute.

  • rate_limit_threshold (int) – Number of allowed requests per client within the time window.

  • match_conditions (list[MatchCondition]) – Required. List of match conditions.

  • action (str or ActionType) – Required. Describes what action to be applied when rule matches. Possible values include: ‘Allow’, ‘Block’, ‘Log’, ‘Redirect’

class azure.mgmt.frontdoor.models.CustomRuleList(*, rules=None, **kwargs)[source]

Bases: msrest.serialization.Model

Defines contents of custom rules.

Parameters

rules (list[CustomRule]) – List of rules

class azure.mgmt.frontdoor.models.Endpoint(*, name: str = None, endpoint: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Defines the endpoint properties.

Parameters

  • name (str) – The name of the endpoint

  • endpoint (str) – The endpoint URL

class azure.mgmt.frontdoor.models.Error(*, code: str = None, message: str = None, target: str = None, details=None, inner_error: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Error.

Parameters
class azure.mgmt.frontdoor.models.ErrorDetails(*, code: str = None, target: str = None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

ErrorDetails.

Parameters

  • code (str) –

  • target (str) –

  • message (str) –

class azure.mgmt.frontdoor.models.ErrorResponse(**kwargs)[source]

Bases: msrest.serialization.Model

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.

Variables

  • code (str) – Error code.

  • message (str) – Error message indicating why the operation failed.

class azure.mgmt.frontdoor.models.Experiment(*, location: str = None, tags=None, description: str = None, endpoint_a=None, endpoint_b=None, enabled_state=None, resource_state=None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.Resource

Defines the properties of an Experiment.

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

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

  • status (str) – The description of Experiment status from the server side

  • script_file_uri (str) – The uri to the Script used in the Experiment

Parameters

  • location (str) – Resource location.

  • tags (dict[str, str]) – Resource tags.

  • description (str) – The description of the details or intents of the Experiment

  • endpoint_a (Endpoint) – The endpoint A of an experiment

  • endpoint_b (Endpoint) – The endpoint B of an experiment

  • enabled_state (str or State) – The state of the Experiment. Possible values include: ‘Enabled’, ‘Disabled’

  • resource_state (str or NetworkExperimentResourceState) – Resource status. Possible values include: ‘Creating’, ‘Enabling’, ‘Enabled’, ‘Disabling’, ‘Disabled’, ‘Deleting’

class azure.mgmt.frontdoor.models.ExperimentUpdateModel(*, tags=None, description: str = None, enabled_state=None, **kwargs)[source]

Bases: msrest.serialization.Model

Defines modifiable attributes of an Experiment.

Parameters

  • tags (dict[str, str]) – Resource tags.

  • description (str) – The description of the intent or details of the Experiment

  • enabled_state (str or State) – The state of the Experiment. Possible values include: ‘Enabled’, ‘Disabled’

class azure.mgmt.frontdoor.models.ForwardingConfiguration(*, custom_forwarding_path: str = None, forwarding_protocol=None, cache_configuration=None, backend_pool=None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.RouteConfiguration

Describes Forwarding Route.

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

Parameters

  • odatatype (str) – Required. Constant filled by server.

  • custom_forwarding_path (str) – A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.

  • forwarding_protocol (str or FrontDoorForwardingProtocol) – Protocol this rule will use when forwarding traffic to backends. Possible values include: ‘HttpOnly’, ‘HttpsOnly’, ‘MatchRequest’

  • cache_configuration (CacheConfiguration) – The caching configuration associated with this rule.

  • backend_pool (SubResource) – A reference to the BackendPool which this rule routes to.

class azure.mgmt.frontdoor.models.FrontDoor(*, location: str = None, tags=None, friendly_name: str = None, routing_rules=None, load_balancing_settings=None, health_probe_settings=None, backend_pools=None, frontend_endpoints=None, backend_pools_settings=None, enabled_state=None, resource_state=None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.Resource

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.

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

  • provisioning_state (str) – Provisioning state of the Front Door.

  • cname (str) – The host that each frontendEndpoint must CNAME to.

Parameters

  • location (str) – Resource location.

  • tags (dict[str, str]) – Resource tags.

  • friendly_name (str) – A friendly name for the frontDoor

  • routing_rules (list[RoutingRule]) – Routing rules associated with this Front Door.

  • load_balancing_settings (list[LoadBalancingSettingsModel]) – Load balancing settings associated with this Front Door instance.

  • health_probe_settings (list[HealthProbeSettingsModel]) – Health probe settings associated with this Front Door instance.

  • backend_pools (list[BackendPool]) – Backend pools available to routing rules.

  • frontend_endpoints (list[FrontendEndpoint]) – Frontend endpoints available to routing rules.

  • backend_pools_settings (BackendPoolsSettings) – Settings for all backendPools

  • enabled_state (str or FrontDoorEnabledState) – Operational status of the Front Door load balancer. Permitted values are ‘Enabled’ or ‘Disabled’. Possible values include: ‘Enabled’, ‘Disabled’

  • resource_state (str or FrontDoorResourceState) – Resource status of the Front Door. Possible values include: ‘Creating’, ‘Enabling’, ‘Enabled’, ‘Disabling’, ‘Disabled’, ‘Deleting’

class azure.mgmt.frontdoor.models.FrontDoorUpdateParameters(*, friendly_name: str = None, routing_rules=None, load_balancing_settings=None, health_probe_settings=None, backend_pools=None, frontend_endpoints=None, backend_pools_settings=None, enabled_state=None, **kwargs)[source]

Bases: msrest.serialization.Model

The properties needed to update a Front Door.

Parameters

  • friendly_name (str) – A friendly name for the frontDoor

  • routing_rules (list[RoutingRule]) – Routing rules associated with this Front Door.

  • load_balancing_settings (list[LoadBalancingSettingsModel]) – Load balancing settings associated with this Front Door instance.

  • health_probe_settings (list[HealthProbeSettingsModel]) – Health probe settings associated with this Front Door instance.

  • backend_pools (list[BackendPool]) – Backend pools available to routing rules.

  • frontend_endpoints (list[FrontendEndpoint]) – Frontend endpoints available to routing rules.

  • backend_pools_settings (BackendPoolsSettings) – Settings for all backendPools

  • enabled_state (str or FrontDoorEnabledState) – Operational status of the Front Door load balancer. Permitted values are ‘Enabled’ or ‘Disabled’. Possible values include: ‘Enabled’, ‘Disabled’

class azure.mgmt.frontdoor.models.FrontendEndpoint(*, id: str = None, host_name: str = None, session_affinity_enabled_state=None, session_affinity_ttl_seconds: int = None, web_application_firewall_policy_link=None, resource_state=None, name: str = None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.SubResource

A frontend endpoint used for routing.

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

Parameters

  • id (str) – Resource ID.

  • host_name (str) – The host name of the frontendEndpoint. Must be a domain name.

  • session_affinity_enabled_state (str or SessionAffinityEnabledState) – Whether to allow session affinity on this host. Valid options are ‘Enabled’ or ‘Disabled’. Possible values include: ‘Enabled’, ‘Disabled’

  • session_affinity_ttl_seconds (int) – UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable.

  • web_application_firewall_policy_link (FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for each host (if applicable)

  • resource_state (str or FrontDoorResourceState) – Resource status. Possible values include: ‘Creating’, ‘Enabling’, ‘Enabled’, ‘Disabling’, ‘Disabled’, ‘Deleting’

  • name (str) – Resource name.

Variables

  • custom_https_provisioning_state (str or CustomHttpsProvisioningState) – Provisioning status of Custom Https of the frontendEndpoint. Possible values include: ‘Enabling’, ‘Enabled’, ‘Disabling’, ‘Disabled’, ‘Failed’

  • custom_https_provisioning_substate (str or CustomHttpsProvisioningSubstate) – Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. Possible values include: ‘SubmittingDomainControlValidationRequest’, ‘PendingDomainControlValidationREquestApproval’, ‘DomainControlValidationRequestApproved’, ‘DomainControlValidationRequestRejected’, ‘DomainControlValidationRequestTimedOut’, ‘IssuingCertificate’, ‘DeployingCertificate’, ‘CertificateDeployed’, ‘DeletingCertificate’, ‘CertificateDeleted’

  • custom_https_configuration (CustomHttpsConfiguration) – The configuration specifying how to enable HTTPS

  • type (str) – Resource type.

Bases: msrest.serialization.Model

Defines the Resource ID for a Frontend Endpoint.

Parameters

id (str) – Resource ID.

class azure.mgmt.frontdoor.models.FrontendEndpointUpdateParameters(*, host_name: str = None, session_affinity_enabled_state=None, session_affinity_ttl_seconds: int = None, web_application_firewall_policy_link=None, **kwargs)[source]

Bases: msrest.serialization.Model

Frontend endpoint used in routing rule.

Parameters

  • host_name (str) – The host name of the frontendEndpoint. Must be a domain name.

  • session_affinity_enabled_state (str or SessionAffinityEnabledState) – Whether to allow session affinity on this host. Valid options are ‘Enabled’ or ‘Disabled’. Possible values include: ‘Enabled’, ‘Disabled’

  • session_affinity_ttl_seconds (int) – UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable.

  • web_application_firewall_policy_link (FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for each host (if applicable)

Bases: msrest.serialization.Model

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

Parameters

id (str) – Resource ID.

class azure.mgmt.frontdoor.models.HealthProbeSettingsListResult(*, next_link: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Variables

value (list[HealthProbeSettingsModel]) – List of HealthProbeSettings within a Front Door.

Parameters

next_link (str) – URL to get the next set of HealthProbeSettings objects if there are any.

class azure.mgmt.frontdoor.models.HealthProbeSettingsModel(*, id: str = None, path: str = None, protocol=None, interval_in_seconds: int = None, health_probe_method='HEAD', enabled_state=None, resource_state=None, name: str = None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.SubResource

Load balancing settings for a backend pool.

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

Parameters

  • id (str) – Resource ID.

  • path (str) – The path to use for the health probe. Default is /

  • protocol (str or FrontDoorProtocol) – Protocol scheme to use for this probe. Possible values include: ‘Http’, ‘Https’

  • interval_in_seconds (int) – The number of seconds between health probes.

  • health_probe_method (str or FrontDoorHealthProbeMethod) – Configures which HTTP method to use to probe the backends defined under backendPools. Possible values include: ‘GET’, ‘HEAD’. Default value: “HEAD” .

  • enabled_state (str or 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. Possible values include: ‘Enabled’, ‘Disabled’

  • resource_state (str or FrontDoorResourceState) – Resource status. Possible values include: ‘Creating’, ‘Enabling’, ‘Enabled’, ‘Disabling’, ‘Disabled’, ‘Deleting’

  • name (str) – Resource name.

Variables

type (str) – Resource type.

class azure.mgmt.frontdoor.models.HealthProbeSettingsUpdateParameters(*, path: str = None, protocol=None, interval_in_seconds: int = None, health_probe_method='HEAD', enabled_state=None, **kwargs)[source]

Bases: msrest.serialization.Model

L7 health probe settings for a backend pool.

Parameters

  • path (str) – The path to use for the health probe. Default is /

  • protocol (str or FrontDoorProtocol) – Protocol scheme to use for this probe. Possible values include: ‘Http’, ‘Https’

  • interval_in_seconds (int) – The number of seconds between health probes.

  • health_probe_method (str or FrontDoorHealthProbeMethod) – Configures which HTTP method to use to probe the backends defined under backendPools. Possible values include: ‘GET’, ‘HEAD’. Default value: “HEAD” .

  • enabled_state (str or 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. Possible values include: ‘Enabled’, ‘Disabled’

class azure.mgmt.frontdoor.models.KeyVaultCertificateSourceParametersVault(*, id: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The Key Vault containing the SSL certificate.

Parameters

id (str) – Resource ID.

class azure.mgmt.frontdoor.models.LatencyMetric(**kwargs)[source]

Bases: msrest.serialization.Model

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.

Variables

  • name (str) – The name of the Latency Metric

  • end_date_time_utc (str) – The end time of the Latency Scorecard in UTC

  • a_value (float) – The metric value of the A endpoint

  • b_value (float) – The metric value of the B endpoint

  • delta (float) – The difference in value between endpoint A and B

  • delta_percent (float) – The percent difference between endpoint A and B

  • a_clower95_ci (float) – The lower end of the 95% confidence interval for endpoint A

  • a_hupper95_ci (float) – The upper end of the 95% confidence interval for endpoint A

  • b_clower95_ci (float) – The lower end of the 95% confidence interval for endpoint B

  • b_upper95_ci (float) – The upper end of the 95% confidence interval for endpoint B

class azure.mgmt.frontdoor.models.LatencyScorecard(*, location: str = None, tags=None, latency_metrics=None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.Resource

Defines the LatencyScorecard.

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

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

  • latency_scorecard_id (str) – The unique identifier of the Latency Scorecard

  • latency_scorecard_name (str) – The name of the Latency Scorecard

  • description (str) – The description of the Latency Scorecard

  • endpoint_a (str) – The A endpoint in the scorecard

  • endpoint_b (str) – The B endpoint in the scorecard

  • start_date_time_utc (datetime) – The start time of the Latency Scorecard in UTC

  • end_date_time_utc (datetime) – The end time of the Latency Scorecard in UTC

  • country (str) – The country associated with the Latency Scorecard. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html

Parameters

  • location (str) – Resource location.

  • tags (dict[str, str]) – Resource tags.

  • latency_metrics (list[LatencyMetric]) – The latency metrics of the Latency Scorecard

class azure.mgmt.frontdoor.models.LoadBalancingSettingsListResult(*, next_link: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Variables

value (list[LoadBalancingSettingsModel]) – List of Backend Pools within a Front Door.

Parameters

next_link (str) – URL to get the next set of LoadBalancingSettings objects if there are any.

class azure.mgmt.frontdoor.models.LoadBalancingSettingsModel(*, id: str = None, sample_size: int = None, successful_samples_required: int = None, additional_latency_milliseconds: int = None, resource_state=None, name: str = None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.SubResource

Load balancing settings for a backend pool.

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

Parameters

  • id (str) – Resource ID.

  • sample_size (int) – The number of samples to consider for load balancing decisions

  • successful_samples_required (int) – The number of samples within the sample period that must succeed

  • additional_latency_milliseconds (int) – The additional latency in milliseconds for probes to fall into the lowest latency bucket

  • resource_state (str or FrontDoorResourceState) – Resource status. Possible values include: ‘Creating’, ‘Enabling’, ‘Enabled’, ‘Disabling’, ‘Disabled’, ‘Deleting’

  • name (str) – Resource name.

Variables

type (str) – Resource type.

class azure.mgmt.frontdoor.models.LoadBalancingSettingsUpdateParameters(*, sample_size: int = None, successful_samples_required: int = None, additional_latency_milliseconds: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Round-Robin load balancing settings for a backend pool.

Parameters

  • sample_size (int) – The number of samples to consider for load balancing decisions

  • successful_samples_required (int) – The number of samples within the sample period that must succeed

  • additional_latency_milliseconds (int) – The additional latency in milliseconds for probes to fall into the lowest latency bucket

class azure.mgmt.frontdoor.models.ManagedRuleDefinition(**kwargs)[source]

Bases: msrest.serialization.Model

Describes a managed rule definition.

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

Variables

  • rule_id (str) – Identifier for the managed rule.

  • default_state (str or ManagedRuleEnabledState) – Describes the default state for the managed rule. Possible values include: ‘Disabled’, ‘Enabled’

  • default_action (str or ActionType) – Describes the default action to be applied when the managed rule matches. Possible values include: ‘Allow’, ‘Block’, ‘Log’, ‘Redirect’

  • description (str) – Describes the functionality of the managed rule.

class azure.mgmt.frontdoor.models.ManagedRuleExclusion(*, match_variable, selector_match_operator, selector: str, **kwargs)[source]

Bases: msrest.serialization.Model

Exclude variables from managed rule evaluation.

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

Parameters

  • match_variable (str or ManagedRuleExclusionMatchVariable) – Required. The variable type to be excluded. Possible values include: ‘RequestHeaderNames’, ‘RequestCookieNames’, ‘QueryStringArgNames’, ‘RequestBodyPostArgNames’

  • selector_match_operator (str or ManagedRuleExclusionSelectorMatchOperator) – Required. Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. Possible values include: ‘Equals’, ‘Contains’, ‘StartsWith’, ‘EndsWith’, ‘EqualsAny’

  • selector (str) – Required. Selector value for which elements in the collection this exclusion applies to.

class azure.mgmt.frontdoor.models.ManagedRuleGroupDefinition(**kwargs)[source]

Bases: msrest.serialization.Model

Describes a managed rule group.

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

Variables

  • rule_group_name (str) – Name of the managed rule group.

  • description (str) – Description of the managed rule group.

  • rules (list[ManagedRuleDefinition]) – List of rules within the managed rule group.

class azure.mgmt.frontdoor.models.ManagedRuleGroupOverride(*, rule_group_name: str, exclusions=None, rules=None, **kwargs)[source]

Bases: msrest.serialization.Model

Defines a managed rule group override setting.

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

Parameters

  • rule_group_name (str) – Required. Describes the managed rule group to override.

  • exclusions (list[ManagedRuleExclusion]) – Describes the exclusions that are applied to all rules in the group.

  • rules (list[ManagedRuleOverride]) – List of rules that will be disabled. If none specified, all rules in the group will be disabled.

class azure.mgmt.frontdoor.models.ManagedRuleOverride(*, rule_id: str, enabled_state=None, action=None, exclusions=None, **kwargs)[source]

Bases: msrest.serialization.Model

Defines a managed rule group override setting.

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

Parameters

  • rule_id (str) – Required. Identifier for the managed rule.

  • enabled_state (str or ManagedRuleEnabledState) – Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. Possible values include: ‘Disabled’, ‘Enabled’

  • action (str or ActionType) – Describes the override action to be applied when rule matches. Possible values include: ‘Allow’, ‘Block’, ‘Log’, ‘Redirect’

  • exclusions (list[ManagedRuleExclusion]) – Describes the exclusions that are applied to this specific rule.

class azure.mgmt.frontdoor.models.ManagedRuleSet(*, rule_set_type: str, rule_set_version: str, exclusions=None, rule_group_overrides=None, **kwargs)[source]

Bases: msrest.serialization.Model

Defines a managed rule set.

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

Parameters

  • rule_set_type (str) – Required. Defines the rule set type to use.

  • rule_set_version (str) – Required. Defines the version of the rule set to use.

  • exclusions (list[ManagedRuleExclusion]) – Describes the exclusions that are applied to all rules in the set.

  • rule_group_overrides (list[ManagedRuleGroupOverride]) – Defines the rule group overrides to apply to the rule set.

class azure.mgmt.frontdoor.models.ManagedRuleSetDefinition(*, location: str = None, tags=None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.Resource

Describes the a managed rule set definition.

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

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

  • provisioning_state (str) – Provisioning state of the managed rule set.

  • rule_set_type (str) – Type of the managed rule set.

  • rule_set_version (str) – Version of the managed rule set type.

  • rule_groups (list[ManagedRuleGroupDefinition]) – Rule groups of the managed rule set.

Parameters

  • location (str) – Resource location.

  • tags (dict[str, str]) – Resource tags.

class azure.mgmt.frontdoor.models.ManagedRuleSetList(*, managed_rule_sets=None, **kwargs)[source]

Bases: msrest.serialization.Model

Defines the list of managed rule sets for the policy.

Parameters

managed_rule_sets (list[ManagedRuleSet]) – List of rule sets.

class azure.mgmt.frontdoor.models.MatchCondition(*, match_variable, operator, match_value, selector: str = None, negate_condition: bool = None, transforms=None, **kwargs)[source]

Bases: msrest.serialization.Model

Define a match condition.

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

Parameters

  • match_variable (str or MatchVariable) – Required. Request variable to compare with. Possible values include: ‘RemoteAddr’, ‘RequestMethod’, ‘QueryString’, ‘PostArgs’, ‘RequestUri’, ‘RequestHeader’, ‘RequestBody’, ‘Cookies’, ‘SocketAddr’

  • selector (str) – Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null.

  • operator (str or Operator) – Required. Comparison type to use for matching with the variable value. Possible values include: ‘Any’, ‘IPMatch’, ‘GeoMatch’, ‘Equal’, ‘Contains’, ‘LessThan’, ‘GreaterThan’, ‘LessThanOrEqual’, ‘GreaterThanOrEqual’, ‘BeginsWith’, ‘EndsWith’, ‘RegEx’

  • negate_condition (bool) – Describes if the result of this condition should be negated.

  • match_value (list[str]) – Required. List of possible match values.

  • transforms (list[str or TransformType]) – List of transforms.

class azure.mgmt.frontdoor.models.PolicySettings(*, enabled_state=None, mode=None, redirect_url: str = None, custom_block_response_status_code: int = None, custom_block_response_body: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Defines top-level WebApplicationFirewallPolicy configuration settings.

Parameters

  • enabled_state (str or PolicyEnabledState) – Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. Possible values include: ‘Disabled’, ‘Enabled’

  • mode (str or PolicyMode) – Describes if it is in detection mode or prevention mode at policy level. Possible values include: ‘Prevention’, ‘Detection’

  • redirect_url (str) – If action type is redirect, this field represents redirect URL for the client.

  • custom_block_response_status_code (int) – If the action type is block, customer can override the response status code.

  • custom_block_response_body (str) – If the action type is block, customer can override the response body. The body must be specified in base64 encoding.

class azure.mgmt.frontdoor.models.PreconfiguredEndpoint(*, location: str = None, tags=None, description: str = None, endpoint: str = None, endpoint_type=None, backend: str = None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.Resource

Defines the properties of a preconfigured endpoint.

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

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

Parameters

  • location (str) – Resource location.

  • tags (dict[str, str]) – Resource tags.

  • description (str) – The description of the endpoint

  • endpoint (str) – The endpoint that is preconfigured

  • endpoint_type (str or EndpointType) – The type of endpoint. Possible values include: ‘AFD’, ‘AzureRegion’, ‘CDN’, ‘ATM’

  • backend (str) – The preconfigured endpoint backend

class azure.mgmt.frontdoor.models.Profile(*, location: str = None, tags=None, resource_state=None, enabled_state=None, etag: str = None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.Resource

Defines an Network Experiment Profile and lists of Experiments.

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

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

Parameters

  • location (str) – Resource location.

  • tags (dict[str, str]) – Resource tags.

  • resource_state (str or NetworkExperimentResourceState) – Resource status. Possible values include: ‘Creating’, ‘Enabling’, ‘Enabled’, ‘Disabling’, ‘Disabled’, ‘Deleting’

  • enabled_state (str or State) – The state of the Experiment. Possible values include: ‘Enabled’, ‘Disabled’

  • etag (str) – Gets a unique read-only string that changes whenever the resource is updated.

class azure.mgmt.frontdoor.models.ProfileUpdateModel(*, enabled_state=None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

Defines modifiable attributes of a Profile.

Parameters

  • enabled_state (str or State) – The enabled state of the Profile. Possible values include: ‘Enabled’, ‘Disabled’

  • tags (dict[str, str]) – Resource tags.

class azure.mgmt.frontdoor.models.PurgeParameters(*, content_paths, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters required for content purge.

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

Parameters

content_paths (list[str]) – Required. The path to the content to be purged. Can describe a file path or a wild card directory.

class azure.mgmt.frontdoor.models.RedirectConfiguration(*, redirect_type=None, redirect_protocol=None, custom_host: str = None, custom_path: str = None, custom_fragment: str = None, custom_query_string: str = None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.RouteConfiguration

Describes Redirect Route.

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

Parameters

  • odatatype (str) – Required. Constant filled by server.

  • redirect_type (str or FrontDoorRedirectType) – The redirect type the rule will use when redirecting traffic. Possible values include: ‘Moved’, ‘Found’, ‘TemporaryRedirect’, ‘PermanentRedirect’

  • redirect_protocol (str or FrontDoorRedirectProtocol) – The protocol of the destination to where the traffic is redirected. Possible values include: ‘HttpOnly’, ‘HttpsOnly’, ‘MatchRequest’

  • custom_host (str) – Host to redirect. Leave empty to use the incoming host as the destination host.

  • custom_path (str) – The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.

  • custom_fragment (str) – Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.

  • custom_query_string (str) – The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in <key>=<value> format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.

class azure.mgmt.frontdoor.models.Resource(*, location: str = None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

Common resource representation.

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

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

Parameters

  • location (str) – Resource location.

  • tags (dict[str, str]) – Resource tags.

class azure.mgmt.frontdoor.models.RouteConfiguration(**kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters

odatatype (str) – Required. Constant filled by server.

class azure.mgmt.frontdoor.models.RoutingRule(*, id: str = None, frontend_endpoints=None, accepted_protocols=None, patterns_to_match=None, enabled_state=None, route_configuration=None, resource_state=None, name: str = None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.SubResource

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.

Parameters

  • id (str) – Resource ID.

  • frontend_endpoints (list[SubResource]) – Frontend endpoints associated with this rule

  • accepted_protocols (list[str or FrontDoorProtocol]) – Protocol schemes to match for this rule

  • patterns_to_match (list[str]) – The route patterns of the rule.

  • enabled_state (str or RoutingRuleEnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Possible values include: ‘Enabled’, ‘Disabled’

  • route_configuration (RouteConfiguration) – A reference to the routing configuration.

  • resource_state (str or FrontDoorResourceState) – Resource status. Possible values include: ‘Creating’, ‘Enabling’, ‘Enabled’, ‘Disabling’, ‘Disabled’, ‘Deleting’

  • name (str) – Resource name.

Variables

type (str) – Resource type.

class azure.mgmt.frontdoor.models.RoutingRuleListResult(*, next_link: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Variables

value (list[RoutingRule]) – List of Routing Rules within a Front Door.

Parameters

next_link (str) – URL to get the next set of RoutingRule objects if there are any.

class azure.mgmt.frontdoor.models.RoutingRuleUpdateParameters(*, frontend_endpoints=None, accepted_protocols=None, patterns_to_match=None, enabled_state=None, route_configuration=None, **kwargs)[source]

Bases: msrest.serialization.Model

Routing rules to apply to an endpoint.

Parameters

  • frontend_endpoints (list[SubResource]) – Frontend endpoints associated with this rule

  • accepted_protocols (list[str or FrontDoorProtocol]) – Protocol schemes to match for this rule

  • patterns_to_match (list[str]) – The route patterns of the rule.

  • enabled_state (str or RoutingRuleEnabledState) – Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Possible values include: ‘Enabled’, ‘Disabled’

  • route_configuration (RouteConfiguration) – A reference to the routing configuration.

class azure.mgmt.frontdoor.models.SubResource(*, id: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Reference to another subresource.

Parameters

id (str) – Resource ID.

class azure.mgmt.frontdoor.models.TagsObject(*, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

Tags object for patch operations.

Parameters

tags (dict[str, str]) – Resource tags.

class azure.mgmt.frontdoor.models.Timeseries(*, location: str = None, tags=None, endpoint: str = None, start_date_time_utc: str = None, end_date_time_utc: str = None, aggregation_interval=None, timeseries_type=None, country: str = None, timeseries_data=None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.Resource

Defines the Timeseries.

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

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

Parameters

  • location (str) – Resource location.

  • tags (dict[str, str]) – Resource tags.

  • endpoint (str) – The endpoint associated with the Timeseries data point

  • start_date_time_utc (str) – The start DateTime of the Timeseries in UTC

  • end_date_time_utc (str) – The end DateTime of the Timeseries in UTC

  • aggregation_interval (str or AggregationInterval) – The aggregation interval of the Timeseries. Possible values include: ‘Hourly’, ‘Daily’

  • timeseries_type (str or TimeseriesType) – The type of Timeseries. Possible values include: ‘MeasurementCounts’, ‘LatencyP50’, ‘LatencyP75’, ‘LatencyP95’

  • country (str) – The country associated with the Timeseries. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html

  • timeseries_data (list[TimeseriesDataPoint]) – The set of data points for the timeseries

class azure.mgmt.frontdoor.models.TimeseriesDataPoint(*, date_time_utc: str = None, value: float = None, **kwargs)[source]

Bases: msrest.serialization.Model

Defines a timeseries datapoint used in a timeseries.

Parameters

  • date_time_utc (str) – The DateTime of the Timeseries data point in UTC

  • value (float) – The Value of the Timeseries data point

class azure.mgmt.frontdoor.models.ValidateCustomDomainInput(*, host_name: str, **kwargs)[source]

Bases: msrest.serialization.Model

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

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

Parameters

host_name (str) – Required. The host name of the custom domain. Must be a domain name.

class azure.mgmt.frontdoor.models.ValidateCustomDomainOutput(**kwargs)[source]

Bases: msrest.serialization.Model

Output of custom domain validation.

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

Variables

  • custom_domain_validated (bool) – Indicates whether the custom domain is valid or not.

  • reason (str) – The reason why the custom domain is not valid.

  • message (str) – Error message describing why the custom domain is not valid.

class azure.mgmt.frontdoor.models.WebApplicationFirewallPolicy(*, location: str = None, tags=None, policy_settings=None, custom_rules=None, managed_rules=None, etag: str = None, **kwargs)[source]

Bases: azure.mgmt.frontdoor.models._models_py3.Resource

Defines web application firewall policy.

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

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

  • frontend_endpoint_links (list[FrontendEndpointLink]) – Describes Frontend Endpoints associated with this Web Application Firewall policy.

  • provisioning_state (str) – Provisioning state of the policy.

  • resource_state (str or PolicyResourceState) – Resource status of the policy. Possible values include: ‘Creating’, ‘Enabling’, ‘Enabled’, ‘Disabling’, ‘Disabled’, ‘Deleting’

Parameters

  • location (str) – Resource location.

  • tags (dict[str, str]) – Resource tags.

  • policy_settings (PolicySettings) – Describes settings for the policy.

  • custom_rules (CustomRuleList) – Describes custom rules inside the policy.

  • managed_rules (ManagedRuleSetList) – Describes managed rules inside the policy.

  • etag (str) – Gets a unique read-only string that changes whenever the resource is updated.

class azure.mgmt.frontdoor.models.ProfilePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Profile object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.frontdoor.models.PreconfiguredEndpointPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of PreconfiguredEndpoint object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.frontdoor.models.ExperimentPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Experiment object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.frontdoor.models.FrontDoorPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of FrontDoor object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.frontdoor.models.FrontendEndpointPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of FrontendEndpoint object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.frontdoor.models.WebApplicationFirewallPolicyPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of WebApplicationFirewallPolicy object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.frontdoor.models.ManagedRuleSetDefinitionPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ManagedRuleSetDefinition object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.frontdoor.models.NetworkOperationStatus[source]

Bases: str, enum.Enum

An enumeration.

failed = 'Failed'
in_progress = 'InProgress'
succeeded = 'Succeeded'
class azure.mgmt.frontdoor.models.NetworkExperimentResourceState[source]

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'
deleting = 'Deleting'
disabled = 'Disabled'
disabling = 'Disabling'
enabled = 'Enabled'
enabling = 'Enabling'
class azure.mgmt.frontdoor.models.State[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.frontdoor.models.AggregationInterval[source]

Bases: str, enum.Enum

An enumeration.

daily = 'Daily'
hourly = 'Hourly'
class azure.mgmt.frontdoor.models.TimeseriesType[source]

Bases: str, enum.Enum

An enumeration.

latency_p50 = 'LatencyP50'
latency_p75 = 'LatencyP75'
latency_p95 = 'LatencyP95'
measurement_counts = 'MeasurementCounts'
class azure.mgmt.frontdoor.models.EndpointType[source]

Bases: str, enum.Enum

An enumeration.

afd = 'AFD'
atm = 'ATM'
azure_region = 'AzureRegion'
cdn = 'CDN'
class azure.mgmt.frontdoor.models.FrontDoorResourceState[source]

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'
deleting = 'Deleting'
disabled = 'Disabled'
disabling = 'Disabling'
enabled = 'Enabled'
enabling = 'Enabling'
class azure.mgmt.frontdoor.models.CustomHttpsProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
disabling = 'Disabling'
enabled = 'Enabled'
enabling = 'Enabling'
failed = 'Failed'
class azure.mgmt.frontdoor.models.CustomHttpsProvisioningSubstate[source]

Bases: str, enum.Enum

An enumeration.

certificate_deleted = 'CertificateDeleted'
certificate_deployed = 'CertificateDeployed'
deleting_certificate = 'DeletingCertificate'
deploying_certificate = 'DeployingCertificate'
domain_control_validation_request_approved = 'DomainControlValidationRequestApproved'
domain_control_validation_request_rejected = 'DomainControlValidationRequestRejected'
domain_control_validation_request_timed_out = 'DomainControlValidationRequestTimedOut'
issuing_certificate = 'IssuingCertificate'
pending_domain_control_validation_request_approval = 'PendingDomainControlValidationREquestApproval'
submitting_domain_control_validation_request = 'SubmittingDomainControlValidationRequest'
class azure.mgmt.frontdoor.models.FrontDoorCertificateSource[source]

Bases: str, enum.Enum

An enumeration.

azure_key_vault = 'AzureKeyVault'
front_door = 'FrontDoor'
class azure.mgmt.frontdoor.models.MinimumTLSVersion[source]

Bases: str, enum.Enum

An enumeration.

one_full_stop_two = '1.2'
one_full_stop_zero = '1.0'
class azure.mgmt.frontdoor.models.FrontDoorCertificateType[source]

Bases: str, enum.Enum

An enumeration.

dedicated = 'Dedicated'
class azure.mgmt.frontdoor.models.EnforceCertificateNameCheckEnabledState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.frontdoor.models.FrontDoorEnabledState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.frontdoor.models.FrontDoorProtocol[source]

Bases: str, enum.Enum

An enumeration.

http = 'Http'
https = 'Https'
class azure.mgmt.frontdoor.models.RoutingRuleEnabledState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.frontdoor.models.FrontDoorForwardingProtocol[source]

Bases: str, enum.Enum

An enumeration.

http_only = 'HttpOnly'
https_only = 'HttpsOnly'
match_request = 'MatchRequest'
class azure.mgmt.frontdoor.models.FrontDoorQuery[source]

Bases: str, enum.Enum

An enumeration.

strip_all = 'StripAll'
strip_none = 'StripNone'
class azure.mgmt.frontdoor.models.DynamicCompressionEnabled[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.frontdoor.models.FrontDoorRedirectType[source]

Bases: str, enum.Enum

An enumeration.

found = 'Found'
moved = 'Moved'
permanent_redirect = 'PermanentRedirect'
temporary_redirect = 'TemporaryRedirect'
class azure.mgmt.frontdoor.models.FrontDoorRedirectProtocol[source]

Bases: str, enum.Enum

An enumeration.

http_only = 'HttpOnly'
https_only = 'HttpsOnly'
match_request = 'MatchRequest'
class azure.mgmt.frontdoor.models.BackendEnabledState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.frontdoor.models.FrontDoorHealthProbeMethod[source]

Bases: str, enum.Enum

An enumeration.

get = 'GET'
head = 'HEAD'
class azure.mgmt.frontdoor.models.HealthProbeEnabled[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.frontdoor.models.SessionAffinityEnabledState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.frontdoor.models.ResourceType[source]

Bases: str, enum.Enum

An enumeration.

microsoft_networkfront_doors = 'Microsoft.Network/frontDoors'
microsoft_networkfront_doorsfrontend_endpoints = 'Microsoft.Network/frontDoors/frontendEndpoints'
class azure.mgmt.frontdoor.models.Availability[source]

Bases: str, enum.Enum

An enumeration.

available = 'Available'
unavailable = 'Unavailable'
class azure.mgmt.frontdoor.models.PolicyEnabledState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.frontdoor.models.PolicyMode[source]

Bases: str, enum.Enum

An enumeration.

detection = 'Detection'
prevention = 'Prevention'
class azure.mgmt.frontdoor.models.CustomRuleEnabledState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.frontdoor.models.RuleType[source]

Bases: str, enum.Enum

An enumeration.

match_rule = 'MatchRule'
rate_limit_rule = 'RateLimitRule'
class azure.mgmt.frontdoor.models.MatchVariable[source]

Bases: str, enum.Enum

An enumeration.

cookies = 'Cookies'
post_args = 'PostArgs'
query_string = 'QueryString'
remote_addr = 'RemoteAddr'
request_body = 'RequestBody'
request_header = 'RequestHeader'
request_method = 'RequestMethod'
request_uri = 'RequestUri'
socket_addr = 'SocketAddr'
class azure.mgmt.frontdoor.models.Operator[source]

Bases: str, enum.Enum

An enumeration.

any = 'Any'
begins_with = 'BeginsWith'
contains = 'Contains'
ends_with = 'EndsWith'
equal = 'Equal'
geo_match = 'GeoMatch'
greater_than = 'GreaterThan'
greater_than_or_equal = 'GreaterThanOrEqual'
ip_match = 'IPMatch'
less_than = 'LessThan'
less_than_or_equal = 'LessThanOrEqual'
reg_ex = 'RegEx'
class azure.mgmt.frontdoor.models.TransformType[source]

Bases: str, enum.Enum

An enumeration.

lowercase = 'Lowercase'
remove_nulls = 'RemoveNulls'
trim = 'Trim'
uppercase = 'Uppercase'
url_decode = 'UrlDecode'
url_encode = 'UrlEncode'
class azure.mgmt.frontdoor.models.ActionType[source]

Bases: str, enum.Enum

An enumeration.

allow = 'Allow'
block = 'Block'
log = 'Log'
redirect = 'Redirect'
class azure.mgmt.frontdoor.models.ManagedRuleExclusionMatchVariable[source]

Bases: str, enum.Enum

An enumeration.

query_string_arg_names = 'QueryStringArgNames'
request_body_post_arg_names = 'RequestBodyPostArgNames'
request_header_names = 'RequestHeaderNames'
class azure.mgmt.frontdoor.models.ManagedRuleExclusionSelectorMatchOperator[source]

Bases: str, enum.Enum

An enumeration.

contains = 'Contains'
ends_with = 'EndsWith'
equals = 'Equals'
equals_any = 'EqualsAny'
starts_with = 'StartsWith'
class azure.mgmt.frontdoor.models.ManagedRuleEnabledState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.frontdoor.models.PolicyResourceState[source]

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'
deleting = 'Deleting'
disabled = 'Disabled'
disabling = 'Disabling'
enabled = 'Enabled'
enabling = 'Enabling'
class azure.mgmt.frontdoor.models.LatencyScorecardAggregationInterval[source]

Bases: str, enum.Enum

An enumeration.

daily = 'Daily'
monthly = 'Monthly'
weekly = 'Weekly'
class azure.mgmt.frontdoor.models.TimeseriesAggregationInterval[source]

Bases: str, enum.Enum

An enumeration.

daily = 'Daily'
hourly = 'Hourly'