azure.mgmt.frontdoor.models module¶

class azure.mgmt.frontdoor.models.ActionType(value)[source]¶

Bases: str, enum.Enum

Defines the action to take on rule match.

ALLOW = 'Allow'¶

BLOCK = 'Block'¶

LOG = 'Log'¶

REDIRECT = 'Redirect'¶

class azure.mgmt.frontdoor.models.AggregationInterval(value)[source]¶

Bases: str, enum.Enum

The aggregation interval of the Timeseries.

DAILY = 'Daily'¶

HOURLY = 'Hourly'¶

class azure.mgmt.frontdoor.models.Availability(value)[source]¶

Bases: str, enum.Enum

Indicates whether the name is available.

AVAILABLE = 'Available'¶

UNAVAILABLE = 'Unavailable'¶

class azure.mgmt.frontdoor.models.AzureAsyncOperationResult(*, status: Optional[Union[str, _models.NetworkOperationStatus]] = None, error: Optional[_models.Error] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._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.

Variables

status (str or NetworkOperationStatus) – Status of the Azure async operation. Known values are: “InProgress”, “Succeeded”, and “Failed”.
error (Error) –

Keyword Arguments

status (str or NetworkOperationStatus) – Status of the Azure async operation. Known values are: “InProgress”, “Succeeded”, and “Failed”.
error (Error) –

class azure.mgmt.frontdoor.models.Backend(*, address: Optional[str] = None, private_link_alias: Optional[str] = None, private_link_resource_id: Optional[str] = None, private_link_location: Optional[str] = None, private_link_approval_message: Optional[str] = None, http_port: Optional[int] = None, https_port: Optional[int] = None, enabled_state: Optional[Union[str, _models.BackendEnabledState]] = None, priority: Optional[int] = None, weight: Optional[int] = None, backend_host_header: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Backend address of a frontDoor load balancer.

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

Variables

address (str) – Location of the backend (IP address or FQDN).
private_link_alias (str) – The Alias of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_resource_id (str) – The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_location (str) – The location of the Private Link resource. Required only if ‘privateLinkResourceId’ is populated.
private_endpoint_status (str or PrivateEndpointStatus) – The Approval status for the connection to the Private Link. Known values are: “Pending”, “Approved”, “Rejected”, “Disconnected”, and “Timeout”.
private_link_approval_message (str) – A custom message to be included in the approval request to connect to the Private Link.
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’. Known values are: “Enabled” and “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.

Keyword Arguments

address (str) – Location of the backend (IP address or FQDN).
private_link_alias (str) – The Alias of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_resource_id (str) – The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is ‘Private’.
private_link_location (str) – The location of the Private Link resource. Required only if ‘privateLinkResourceId’ is populated.
private_link_approval_message (str) – A custom message to be included in the approval request to connect to the Private Link.
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’. Known values are: “Enabled” and “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.BackendEnabledState(value)[source]¶

Bases: str, enum.Enum

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

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.frontdoor.models.BackendPool(*, id: Optional[str] = None, name: Optional[str] = None, backends: Optional[List[_models.Backend]] = None, load_balancing_settings: Optional[_models.SubResource] = None, health_probe_settings: Optional[_models.SubResource] = 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.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
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. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.

Keyword Arguments

id (str) – Resource ID.
name (str) – Resource name.
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.BackendPoolListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._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.
next_link (str) – URL to get the next set of BackendPool objects if there are any.

Keyword Arguments

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

class azure.mgmt.frontdoor.models.BackendPoolProperties(*, backends: Optional[List[_models.Backend]] = None, load_balancing_settings: Optional[_models.SubResource] = None, health_probe_settings: Optional[_models.SubResource] = None, **kwargs)[source]¶

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

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.

Variables

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. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.

Keyword Arguments

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.BackendPoolUpdateParameters(*, backends: Optional[List[_models.Backend]] = None, load_balancing_settings: Optional[_models.SubResource] = None, health_probe_settings: Optional[_models.SubResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

A collection of backends that can be routed to.

Variables

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.

Keyword Arguments

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.BackendPoolsSettings(*, enforce_certificate_name_check: Union[str, _models.EnforceCertificateNameCheckEnabledState] = 'Enabled', send_recv_timeout_seconds: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Settings that apply to all backend pools.

Variables

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. Known values are: “Enabled” and “Disabled”.
send_recv_timeout_seconds (int) – Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns.

Keyword Arguments

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. Known values are: “Enabled” and “Disabled”.
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.CacheConfiguration(*, query_parameter_strip_directive: Optional[Union[str, _models.FrontDoorQuery]] = None, query_parameters: Optional[str] = None, dynamic_compression: Optional[Union[str, _models.DynamicCompressionEnabled]] = None, cache_duration: Optional[datetime.timedelta] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

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

Variables

query_parameter_strip_directive (str or FrontDoorQuery) – Treatment of URL query terms when forming the cache key. Known values are: “StripNone”, “StripAll”, “StripOnly”, and “StripAllExcept”.
query_parameters (str) – query parameters to include or exclude (comma separated).
dynamic_compression (str or DynamicCompressionEnabled) – Whether to use dynamic compression for cached content. Known values are: “Enabled” and “Disabled”.
cache_duration (timedelta) – The duration for which the content needs to be cached. Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requires the value to be no more than a year.

Keyword Arguments

query_parameter_strip_directive (str or FrontDoorQuery) – Treatment of URL query terms when forming the cache key. Known values are: “StripNone”, “StripAll”, “StripOnly”, and “StripAllExcept”.
query_parameters (str) – query parameters to include or exclude (comma separated).
dynamic_compression (str or DynamicCompressionEnabled) – Whether to use dynamic compression for cached content. Known values are: “Enabled” and “Disabled”.
cache_duration (timedelta) – The duration for which the content needs to be cached. Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requires the value to be no more than a year.

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

Bases: azure.mgmt.frontdoor._serialization.Model

Input of CheckNameAvailability API.

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

Variables

name (str) – The resource name to validate. Required.
type (str or ResourceType) – The type of the resource whose name is to be validated. Required. Known values are: “Microsoft.Network/frontDoors” and “Microsoft.Network/frontDoors/frontendEndpoints”.

Keyword Arguments

name (str) – The resource name to validate. Required.
type (str or ResourceType) – The type of the resource whose name is to be validated. Required. Known values are: “Microsoft.Network/frontDoors” and “Microsoft.Network/frontDoors/frontendEndpoints”.

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

Bases: azure.mgmt.frontdoor._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. Known values are: “Available” and “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: Union[str, _models.FrontDoorCertificateSource], protocol_type: Union[str, _models.FrontDoorTlsProtocolType], minimum_tls_version: Union[str, _models.MinimumTLSVersion], certificate_type: Optional[Union[str, _models.FrontDoorCertificateType]] = None, vault: Optional[_models.KeyVaultCertificateSourceParametersVault] = None, secret_name: Optional[str] = None, secret_version: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Https settings for a domain.

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

Variables

certificate_source (str or FrontDoorCertificateSource) – Defines the source of the SSL certificate. Required. Known values are: “AzureKeyVault” and “FrontDoor”.
protocol_type (str or FrontDoorTlsProtocolType) – Defines the TLS extension protocol that is used for secure delivery. Required. “ServerNameIndication”
minimum_tls_version (str or MinimumTLSVersion) – The minimum TLS version required from the clients to establish an SSL handshake with Front Door. Required. Known values are: “1.0” and “1.2”.
certificate_type (str or FrontDoorCertificateType) – Defines the type of the certificate used for secure connections to a frontendEndpoint. “Dedicated”
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.

Keyword Arguments

certificate_source (str or FrontDoorCertificateSource) – Defines the source of the SSL certificate. Required. Known values are: “AzureKeyVault” and “FrontDoor”.
protocol_type (str or FrontDoorTlsProtocolType) – Defines the TLS extension protocol that is used for secure delivery. Required. “ServerNameIndication”
minimum_tls_version (str or MinimumTLSVersion) – The minimum TLS version required from the clients to establish an SSL handshake with Front Door. Required. Known values are: “1.0” and “1.2”.
certificate_type (str or FrontDoorCertificateType) – Defines the type of the certificate used for secure connections to a frontendEndpoint. “Dedicated”
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.

class azure.mgmt.frontdoor.models.CustomHttpsProvisioningState(value)[source]¶

Bases: str, enum.Enum

Provisioning status of Custom Https of the frontendEndpoint.

DISABLED = 'Disabled'¶

DISABLING = 'Disabling'¶

ENABLED = 'Enabled'¶

ENABLING = 'Enabling'¶

FAILED = 'Failed'¶

class azure.mgmt.frontdoor.models.CustomHttpsProvisioningSubstate(value)[source]¶

Bases: str, enum.Enum

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

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_R_EQUEST_APPROVAL = 'PendingDomainControlValidationREquestApproval'¶

SUBMITTING_DOMAIN_CONTROL_VALIDATION_REQUEST = 'SubmittingDomainControlValidationRequest'¶

class azure.mgmt.frontdoor.models.CustomRule(*, priority: int, rule_type: Union[str, _models.RuleType], match_conditions: List[_models.MatchCondition], action: Union[str, _models.ActionType], name: Optional[str] = None, enabled_state: Optional[Union[str, _models.CustomRuleEnabledState]] = None, rate_limit_duration_in_minutes: Optional[int] = None, rate_limit_threshold: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Defines contents of a web application rule.

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

Variables

name (str) – Describes the name of the rule.
priority (int) – Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. Required.
enabled_state (str or CustomRuleEnabledState) – Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. Known values are: “Disabled” and “Enabled”.
rule_type (str or RuleType) – Describes type of rule. Required. Known values are: “MatchRule” and “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]) – List of match conditions. Required.
action (str or ActionType) – Describes what action to be applied when rule matches. Required. Known values are: “Allow”, “Block”, “Log”, and “Redirect”.

Keyword Arguments

name (str) – Describes the name of the rule.
priority (int) – Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. Required.
enabled_state (str or CustomRuleEnabledState) – Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. Known values are: “Disabled” and “Enabled”.
rule_type (str or RuleType) – Describes type of rule. Required. Known values are: “MatchRule” and “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]) – List of match conditions. Required.
action (str or ActionType) – Describes what action to be applied when rule matches. Required. Known values are: “Allow”, “Block”, “Log”, and “Redirect”.

class azure.mgmt.frontdoor.models.CustomRuleEnabledState(value)[source]¶

Bases: str, enum.Enum

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

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.frontdoor.models.CustomRuleList(*, rules: Optional[List[_models.CustomRule]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Defines contents of custom rules.

Variables: rules (list[CustomRule]) – List of rules.
Keyword Arguments: rules (list[CustomRule]) – List of rules.

class azure.mgmt.frontdoor.models.DynamicCompressionEnabled(value)[source]¶

Bases: str, enum.Enum

Whether to use dynamic compression for cached content.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

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

Bases: azure.mgmt.frontdoor._serialization.Model

Defines the endpoint properties.

Variables

name (str) – The name of the endpoint.
endpoint (str) – The endpoint URL.

Keyword Arguments

name (str) – The name of the endpoint.
endpoint (str) – The endpoint URL.

class azure.mgmt.frontdoor.models.EndpointType(value)[source]¶

Bases: str, enum.Enum

The type of endpoint.

AFD = 'AFD'¶

ATM = 'ATM'¶

AZURE_REGION = 'AzureRegion'¶

CDN = 'CDN'¶

class azure.mgmt.frontdoor.models.EnforceCertificateNameCheckEnabledState(value)[source]¶

Bases: str, enum.Enum

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

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

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

Bases: azure.mgmt.frontdoor._serialization.Model

Error.

Variables

code (str) –
message (str) –
target (str) –
details (list[ErrorDetails]) –
inner_error (str) –

Keyword Arguments

code (str) –
message (str) –
target (str) –
details (list[ErrorDetails]) –
inner_error (str) –

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

Bases: azure.mgmt.frontdoor._serialization.Model

ErrorDetails.

Variables

code (str) –
target (str) –
message (str) –

Keyword Arguments

code (str) –
target (str) –
message (str) –

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

Bases: azure.mgmt.frontdoor._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: Optional[str] = None, tags: Optional[Dict[str, str]] = None, description: Optional[str] = None, endpoint_a: Optional[_models.Endpoint] = None, endpoint_b: Optional[_models.Endpoint] = None, enabled_state: Optional[Union[str, _models.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.
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. Known values are: “Enabled” and “Disabled”.
resource_state (str or NetworkExperimentResourceState) – Resource status. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, and “Deleting”.
status (str) – The description of Experiment status from the server side.
script_file_uri (str) – The uri to the Script used in the Experiment.

Keyword Arguments

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. Known values are: “Enabled” and “Disabled”.

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

Bases: azure.mgmt.frontdoor._serialization.Model

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.

Variables

value (list[Experiment]) – List of Experiments within a resource group.
next_link (str) – URL to get the next set of Experiment objects if there are any.

Keyword Arguments

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

class azure.mgmt.frontdoor.models.ExperimentUpdateModel(*, tags: Optional[Dict[str, str]] = None, description: Optional[str] = None, enabled_state: Optional[Union[str, _models.State]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Defines modifiable attributes of an Experiment.

Variables

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. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

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. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.frontdoor.models.ForwardingConfiguration(*, custom_forwarding_path: Optional[str] = None, forwarding_protocol: Optional[Union[str, _models.FrontDoorForwardingProtocol]] = None, cache_configuration: Optional[_models.CacheConfiguration] = None, backend_pool: Optional[_models.SubResource] = 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.

Variables

odata_type (str) – Required.
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. Known values are: “HttpOnly”, “HttpsOnly”, and “MatchRequest”.
cache_configuration (CacheConfiguration) – The caching configuration associated with this rule.
backend_pool (SubResource) – A reference to the BackendPool which this rule routes to.

Keyword Arguments

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. Known values are: “HttpOnly”, “HttpsOnly”, and “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: Optional[str] = None, tags: Optional[Dict[str, str]] = None, friendly_name: Optional[str] = None, routing_rules: Optional[List[_models.RoutingRule]] = None, load_balancing_settings: Optional[List[_models.LoadBalancingSettingsModel]] = None, health_probe_settings: Optional[List[_models.HealthProbeSettingsModel]] = None, backend_pools: Optional[List[_models.BackendPool]] = None, frontend_endpoints: Optional[List[_models.FrontendEndpoint]] = None, backend_pools_settings: Optional[_models.BackendPoolsSettings] = None, enabled_state: Optional[Union[str, _models.FrontDoorEnabledState]] = 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.
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’. Known values are: “Enabled” and “Disabled”.
resource_state (str or FrontDoorResourceState) – Resource status of the Front Door. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.
provisioning_state (str) – Provisioning state of the Front Door.
cname (str) – The host that each frontendEndpoint must CNAME to.
frontdoor_id (str) – The Id of the frontdoor.
rules_engines (list[RulesEngine]) – Rules Engine Configurations available to routing rules.
extended_properties (dict[str, str]) – Key-Value pair representing additional properties for frontdoor.

Keyword Arguments

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’. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.frontdoor.models.FrontDoorCertificateSource(value)[source]¶

Bases: str, enum.Enum

Defines the source of the SSL certificate.

AZURE_KEY_VAULT = 'AzureKeyVault'¶

FRONT_DOOR = 'FrontDoor'¶

class azure.mgmt.frontdoor.models.FrontDoorCertificateType(value)[source]¶

Bases: str, enum.Enum

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

DEDICATED = 'Dedicated'¶

class azure.mgmt.frontdoor.models.FrontDoorEnabledState(value)[source]¶

Bases: str, enum.Enum

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

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.frontdoor.models.FrontDoorForwardingProtocol(value)[source]¶

Bases: str, enum.Enum

Protocol this rule will use when forwarding traffic to backends.

HTTPS_ONLY = 'HttpsOnly'¶

HTTP_ONLY = 'HttpOnly'¶

MATCH_REQUEST = 'MatchRequest'¶

class azure.mgmt.frontdoor.models.FrontDoorHealthProbeMethod(value)[source]¶

Bases: str, enum.Enum

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

GET = 'GET'¶

HEAD = 'HEAD'¶

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

Bases: azure.mgmt.frontdoor._serialization.Model

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.

Variables

value (list[FrontDoor]) – List of Front Doors within a resource group.
next_link (str) – URL to get the next set of Front Door objects if there are any.

Keyword Arguments

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

class azure.mgmt.frontdoor.models.FrontDoorProperties(*, friendly_name: Optional[str] = None, routing_rules: Optional[List[_models.RoutingRule]] = None, load_balancing_settings: Optional[List[_models.LoadBalancingSettingsModel]] = None, health_probe_settings: Optional[List[_models.HealthProbeSettingsModel]] = None, backend_pools: Optional[List[_models.BackendPool]] = None, frontend_endpoints: Optional[List[_models.FrontendEndpoint]] = None, backend_pools_settings: Optional[_models.BackendPoolsSettings] = None, enabled_state: Optional[Union[str, _models.FrontDoorEnabledState]] = None, **kwargs)[source]¶

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

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.

Variables

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’. Known values are: “Enabled” and “Disabled”.
resource_state (str or FrontDoorResourceState) – Resource status of the Front Door. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.
provisioning_state (str) – Provisioning state of the Front Door.
cname (str) – The host that each frontendEndpoint must CNAME to.
frontdoor_id (str) – The Id of the frontdoor.
rules_engines (list[RulesEngine]) – Rules Engine Configurations available to routing rules.
extended_properties (dict[str, str]) – Key-Value pair representing additional properties for frontdoor.

Keyword Arguments

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’. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.frontdoor.models.FrontDoorProtocol(value)[source]¶

Bases: str, enum.Enum

Accepted protocol schemes.

HTTP = 'Http'¶

HTTPS = 'Https'¶

class azure.mgmt.frontdoor.models.FrontDoorQuery(value)[source]¶

Bases: str, enum.Enum

Treatment of URL query terms when forming the cache key.

STRIP_ALL = 'StripAll'¶

STRIP_ALL_EXCEPT = 'StripAllExcept'¶

STRIP_NONE = 'StripNone'¶

STRIP_ONLY = 'StripOnly'¶

class azure.mgmt.frontdoor.models.FrontDoorRedirectProtocol(value)[source]¶

Bases: str, enum.Enum

The protocol of the destination to where the traffic is redirected.

HTTPS_ONLY = 'HttpsOnly'¶

HTTP_ONLY = 'HttpOnly'¶

MATCH_REQUEST = 'MatchRequest'¶

class azure.mgmt.frontdoor.models.FrontDoorRedirectType(value)[source]¶

Bases: str, enum.Enum

The redirect type the rule will use when redirecting traffic.

FOUND = 'Found'¶

MOVED = 'Moved'¶

PERMANENT_REDIRECT = 'PermanentRedirect'¶

TEMPORARY_REDIRECT = 'TemporaryRedirect'¶

class azure.mgmt.frontdoor.models.FrontDoorResourceState(value)[source]¶

Bases: str, enum.Enum

Resource status of the Front Door or Front Door SubResource.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

DISABLED = 'Disabled'¶

DISABLING = 'Disabling'¶

ENABLED = 'Enabled'¶

ENABLING = 'Enabling'¶

MIGRATED = 'Migrated'¶

MIGRATING = 'Migrating'¶

class azure.mgmt.frontdoor.models.FrontDoorTlsProtocolType(value)[source]¶

Bases: str, enum.Enum

Defines the TLS extension protocol that is used for secure delivery.

SERVER_NAME_INDICATION = 'ServerNameIndication'¶

class azure.mgmt.frontdoor.models.FrontDoorUpdateParameters(*, friendly_name: Optional[str] = None, routing_rules: Optional[List[_models.RoutingRule]] = None, load_balancing_settings: Optional[List[_models.LoadBalancingSettingsModel]] = None, health_probe_settings: Optional[List[_models.HealthProbeSettingsModel]] = None, backend_pools: Optional[List[_models.BackendPool]] = None, frontend_endpoints: Optional[List[_models.FrontendEndpoint]] = None, backend_pools_settings: Optional[_models.BackendPoolsSettings] = None, enabled_state: Optional[Union[str, _models.FrontDoorEnabledState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

The properties needed to update a Front Door.

Variables

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’. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

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’. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.frontdoor.models.FrontendEndpoint(*, id: Optional[str] = None, name: Optional[str] = None, host_name: Optional[str] = None, session_affinity_enabled_state: Optional[Union[str, _models.SessionAffinityEnabledState]] = None, session_affinity_ttl_seconds: Optional[int] = None, web_application_firewall_policy_link: Optional[_models.FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink] = 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.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
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’. Known values are: “Enabled” and “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. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.
custom_https_provisioning_state (str or CustomHttpsProvisioningState) – Provisioning status of Custom Https of the frontendEndpoint. Known values are: “Enabling”, “Enabled”, “Disabling”, “Disabled”, and “Failed”.
custom_https_provisioning_substate (str or CustomHttpsProvisioningSubstate) – Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. Known values are: “SubmittingDomainControlValidationRequest”, “PendingDomainControlValidationREquestApproval”, “DomainControlValidationRequestApproved”, “DomainControlValidationRequestRejected”, “DomainControlValidationRequestTimedOut”, “IssuingCertificate”, “DeployingCertificate”, “CertificateDeployed”, “DeletingCertificate”, and “CertificateDeleted”.
custom_https_configuration (CustomHttpsConfiguration) – The configuration specifying how to enable HTTPS.

Keyword Arguments

id (str) – Resource ID.
name (str) – Resource name.
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’. Known values are: “Enabled” and “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).

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

Bases: azure.mgmt.frontdoor._serialization.Model

Defines the Resource ID for a Frontend Endpoint.

Variables: id (str) – Resource ID.
Keyword Arguments: id (str) – Resource ID.

class azure.mgmt.frontdoor.models.FrontendEndpointProperties(*, host_name: Optional[str] = None, session_affinity_enabled_state: Optional[Union[str, _models.SessionAffinityEnabledState]] = None, session_affinity_ttl_seconds: Optional[int] = None, web_application_firewall_policy_link: Optional[_models.FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink] = None, **kwargs)[source]¶

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

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.

Variables

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’. Known values are: “Enabled” and “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. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.
custom_https_provisioning_state (str or CustomHttpsProvisioningState) – Provisioning status of Custom Https of the frontendEndpoint. Known values are: “Enabling”, “Enabled”, “Disabling”, “Disabled”, and “Failed”.
custom_https_provisioning_substate (str or CustomHttpsProvisioningSubstate) – Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. Known values are: “SubmittingDomainControlValidationRequest”, “PendingDomainControlValidationREquestApproval”, “DomainControlValidationRequestApproved”, “DomainControlValidationRequestRejected”, “DomainControlValidationRequestTimedOut”, “IssuingCertificate”, “DeployingCertificate”, “CertificateDeployed”, “DeletingCertificate”, and “CertificateDeleted”.
custom_https_configuration (CustomHttpsConfiguration) – The configuration specifying how to enable HTTPS.

Keyword Arguments

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’. Known values are: “Enabled” and “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).

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

Bases: azure.mgmt.frontdoor._serialization.Model

Frontend endpoint used in routing rule.

Variables

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’. Known values are: “Enabled” and “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).

Keyword Arguments

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’. Known values are: “Enabled” and “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).

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

Bases: azure.mgmt.frontdoor._serialization.Model

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

Variables: id (str) – Resource ID.
Keyword Arguments: id (str) – Resource ID.

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

Bases: azure.mgmt.frontdoor._serialization.Model

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.

Variables

value (list[FrontendEndpoint]) – List of Frontend endpoints within a Front Door.
next_link (str) – URL to get the next set of frontend endpoints if there are any.

Keyword Arguments

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

class azure.mgmt.frontdoor.models.HeaderAction(*, header_action_type: Union[str, _models.HeaderActionType], header_name: str, value: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

An action that can manipulate an http header.

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

Variables

header_action_type (str or HeaderActionType) – Which type of manipulation to apply to the header. Required. Known values are: “Append”, “Delete”, and “Overwrite”.
header_name (str) – The name of the header this action will apply to. Required.
value (str) – The value to update the given header name with. This value is not used if the actionType is Delete.

Keyword Arguments

header_action_type (str or HeaderActionType) – Which type of manipulation to apply to the header. Required. Known values are: “Append”, “Delete”, and “Overwrite”.
header_name (str) – The name of the header this action will apply to. Required.
value (str) – The value to update the given header name with. This value is not used if the actionType is Delete.

class azure.mgmt.frontdoor.models.HeaderActionType(value)[source]¶

Bases: str, enum.Enum

Which type of manipulation to apply to the header.

APPEND = 'Append'¶

DELETE = 'Delete'¶

OVERWRITE = 'Overwrite'¶

class azure.mgmt.frontdoor.models.HealthProbeEnabled(value)[source]¶

Bases: str, enum.Enum

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.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

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

Bases: azure.mgmt.frontdoor._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.
next_link (str) – URL to get the next set of HealthProbeSettings objects if there are any.

Keyword Arguments

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

class azure.mgmt.frontdoor.models.HealthProbeSettingsModel(*, id: Optional[str] = None, name: Optional[str] = None, path: Optional[str] = None, protocol: Optional[Union[str, _models.FrontDoorProtocol]] = None, interval_in_seconds: Optional[int] = None, health_probe_method: Union[str, _models.FrontDoorHealthProbeMethod] = 'HEAD', enabled_state: Optional[Union[str, _models.HealthProbeEnabled]] = 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.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
path (str) – The path to use for the health probe. Default is /.
protocol (str or FrontDoorProtocol) – Protocol scheme to use for this probe. Known values are: “Http” and “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. Known values are: “GET” and “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. Known values are: “Enabled” and “Disabled”.
resource_state (str or FrontDoorResourceState) – Resource status. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.

Keyword Arguments

id (str) – Resource ID.
name (str) – Resource name.
path (str) – The path to use for the health probe. Default is /.
protocol (str or FrontDoorProtocol) – Protocol scheme to use for this probe. Known values are: “Http” and “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. Known values are: “GET” and “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. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.frontdoor.models.HealthProbeSettingsProperties(*, path: Optional[str] = None, protocol: Optional[Union[str, _models.FrontDoorProtocol]] = None, interval_in_seconds: Optional[int] = None, health_probe_method: Union[str, _models.FrontDoorHealthProbeMethod] = 'HEAD', enabled_state: Optional[Union[str, _models.HealthProbeEnabled]] = None, **kwargs)[source]¶

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

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.

Variables

path (str) – The path to use for the health probe. Default is /.
protocol (str or FrontDoorProtocol) – Protocol scheme to use for this probe. Known values are: “Http” and “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. Known values are: “GET” and “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. Known values are: “Enabled” and “Disabled”.
resource_state (str or FrontDoorResourceState) – Resource status. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.

Keyword Arguments

path (str) – The path to use for the health probe. Default is /.
protocol (str or FrontDoorProtocol) – Protocol scheme to use for this probe. Known values are: “Http” and “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. Known values are: “GET” and “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. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.frontdoor.models.HealthProbeSettingsUpdateParameters(*, path: Optional[str] = None, protocol: Optional[Union[str, _models.FrontDoorProtocol]] = None, interval_in_seconds: Optional[int] = None, health_probe_method: Union[str, _models.FrontDoorHealthProbeMethod] = 'HEAD', enabled_state: Optional[Union[str, _models.HealthProbeEnabled]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

L7 health probe settings for a backend pool.

Variables

path (str) – The path to use for the health probe. Default is /.
protocol (str or FrontDoorProtocol) – Protocol scheme to use for this probe. Known values are: “Http” and “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. Known values are: “GET” and “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. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

path (str) – The path to use for the health probe. Default is /.
protocol (str or FrontDoorProtocol) – Protocol scheme to use for this probe. Known values are: “Http” and “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. Known values are: “GET” and “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. Known values are: “Enabled” and “Disabled”.

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

Bases: azure.mgmt.frontdoor._serialization.Model

The Key Vault containing the SSL certificate.

Variables: id (str) – Resource ID.
Keyword Arguments: id (str) – Resource ID.

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

Bases: azure.mgmt.frontdoor._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_c_lower95_ci (float) – The lower end of the 95% confidence interval for endpoint A.
a_h_upper95_ci (float) – The upper end of the 95% confidence interval for endpoint A.
b_c_lower95_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: Optional[str] = None, tags: Optional[Dict[str, str]] = None, latency_metrics: Optional[List[_models.LatencyMetric]] = 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.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
id_properties_id (str) – The unique identifier of the Latency Scorecard.
name_properties_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.
latency_metrics (list[LatencyMetric]) – The latency metrics of the Latency Scorecard.

Keyword Arguments

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.LatencyScorecardAggregationInterval(value)[source]¶

Bases: str, enum.Enum

LatencyScorecardAggregationInterval.

DAILY = 'Daily'¶

MONTHLY = 'Monthly'¶

WEEKLY = 'Weekly'¶

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

Bases: azure.mgmt.frontdoor._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.
next_link (str) – URL to get the next set of LoadBalancingSettings objects if there are any.

Keyword Arguments

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

class azure.mgmt.frontdoor.models.LoadBalancingSettingsModel(*, id: Optional[str] = None, name: Optional[str] = None, sample_size: Optional[int] = None, successful_samples_required: Optional[int] = None, additional_latency_milliseconds: Optional[int] = 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.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
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. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.

Keyword Arguments

id (str) – Resource ID.
name (str) – Resource name.
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.LoadBalancingSettingsProperties(*, sample_size: Optional[int] = None, successful_samples_required: Optional[int] = None, additional_latency_milliseconds: Optional[int] = None, **kwargs)[source]¶

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

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.

Variables

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. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.

Keyword Arguments

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.LoadBalancingSettingsUpdateParameters(*, sample_size: Optional[int] = None, successful_samples_required: Optional[int] = None, additional_latency_milliseconds: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Round-Robin load balancing settings for a backend pool.

Variables

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.

Keyword Arguments

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: azure.mgmt.frontdoor._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. Known values are: “Disabled” and “Enabled”.
default_action (str or ActionType) – Describes the default action to be applied when the managed rule matches. Known values are: “Allow”, “Block”, “Log”, and “Redirect”.
description (str) – Describes the functionality of the managed rule.

class azure.mgmt.frontdoor.models.ManagedRuleEnabledState(value)[source]¶

Bases: str, enum.Enum

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

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

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

Bases: azure.mgmt.frontdoor._serialization.Model

Exclude variables from managed rule evaluation.

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

Variables

match_variable (str or ManagedRuleExclusionMatchVariable) – The variable type to be excluded. Required. Known values are: “RequestHeaderNames”, “RequestCookieNames”, “QueryStringArgNames”, “RequestBodyPostArgNames”, and “RequestBodyJsonArgNames”.
selector_match_operator (str or ManagedRuleExclusionSelectorMatchOperator) – Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. Required. Known values are: “Equals”, “Contains”, “StartsWith”, “EndsWith”, and “EqualsAny”.
selector (str) – Selector value for which elements in the collection this exclusion applies to. Required.

Keyword Arguments

match_variable (str or ManagedRuleExclusionMatchVariable) – The variable type to be excluded. Required. Known values are: “RequestHeaderNames”, “RequestCookieNames”, “QueryStringArgNames”, “RequestBodyPostArgNames”, and “RequestBodyJsonArgNames”.
selector_match_operator (str or ManagedRuleExclusionSelectorMatchOperator) – Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. Required. Known values are: “Equals”, “Contains”, “StartsWith”, “EndsWith”, and “EqualsAny”.
selector (str) – Selector value for which elements in the collection this exclusion applies to. Required.

class azure.mgmt.frontdoor.models.ManagedRuleExclusionMatchVariable(value)[source]¶

Bases: str, enum.Enum

The variable type to be excluded.

QUERY_STRING_ARG_NAMES = 'QueryStringArgNames'¶

REQUEST_BODY_JSON_ARG_NAMES = 'RequestBodyJsonArgNames'¶

REQUEST_BODY_POST_ARG_NAMES = 'RequestBodyPostArgNames'¶

REQUEST_COOKIE_NAMES = 'RequestCookieNames'¶

REQUEST_HEADER_NAMES = 'RequestHeaderNames'¶

class azure.mgmt.frontdoor.models.ManagedRuleExclusionSelectorMatchOperator(value)[source]¶

Bases: str, enum.Enum

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

CONTAINS = 'Contains'¶

ENDS_WITH = 'EndsWith'¶

EQUALS = 'Equals'¶

EQUALS_ANY = 'EqualsAny'¶

STARTS_WITH = 'StartsWith'¶

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

Bases: azure.mgmt.frontdoor._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: Optional[List[_models.ManagedRuleExclusion]] = None, rules: Optional[List[_models.ManagedRuleOverride]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Defines a managed rule group override setting.

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

Variables

rule_group_name (str) – Describes the managed rule group to override. Required.
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.

Keyword Arguments

rule_group_name (str) – Describes the managed rule group to override. Required.
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: Optional[Union[str, _models.ManagedRuleEnabledState]] = None, action: Optional[Union[str, _models.ActionType]] = None, exclusions: Optional[List[_models.ManagedRuleExclusion]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Defines a managed rule group override setting.

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

Variables

rule_id (str) – Identifier for the managed rule. Required.
enabled_state (str or ManagedRuleEnabledState) – Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. Known values are: “Disabled” and “Enabled”.
action (str or ActionType) – Describes the override action to be applied when rule matches. Known values are: “Allow”, “Block”, “Log”, and “Redirect”.
exclusions (list[ManagedRuleExclusion]) – Describes the exclusions that are applied to this specific rule.

Keyword Arguments

rule_id (str) – Identifier for the managed rule. Required.
enabled_state (str or ManagedRuleEnabledState) – Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. Known values are: “Disabled” and “Enabled”.
action (str or ActionType) – Describes the override action to be applied when rule matches. Known values are: “Allow”, “Block”, “Log”, and “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, rule_set_action: Optional[Union[str, _models.ManagedRuleSetActionType]] = None, exclusions: Optional[List[_models.ManagedRuleExclusion]] = None, rule_group_overrides: Optional[List[_models.ManagedRuleGroupOverride]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Defines a managed rule set.

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

Variables

rule_set_type (str) – Defines the rule set type to use. Required.
rule_set_version (str) – Defines the version of the rule set to use. Required.
rule_set_action (str or ManagedRuleSetActionType) – Defines the rule set action. Known values are: “Block”, “Log”, and “Redirect”.
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.

Keyword Arguments

rule_set_type (str) – Defines the rule set type to use. Required.
rule_set_version (str) – Defines the version of the rule set to use. Required.
rule_set_action (str or ManagedRuleSetActionType) – Defines the rule set action. Known values are: “Block”, “Log”, and “Redirect”.
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.ManagedRuleSetActionType(value)[source]¶

Bases: str, enum.Enum

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

BLOCK = 'Block'¶

LOG = 'Log'¶

REDIRECT = 'Redirect'¶

class azure.mgmt.frontdoor.models.ManagedRuleSetDefinition(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = 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.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
provisioning_state (str) – Provisioning state of the managed rule set.
rule_set_id (str) – Id 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.

Keyword Arguments

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

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

Bases: azure.mgmt.frontdoor._serialization.Model

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.

Variables

value (list[ManagedRuleSetDefinition]) – List of managed rule set definitions.
next_link (str) – URL to retrieve next set of managed rule set definitions.

Keyword Arguments

next_link (str) – URL to retrieve next set of managed rule set definitions.

class azure.mgmt.frontdoor.models.ManagedRuleSetList(*, managed_rule_sets: Optional[List[_models.ManagedRuleSet]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Defines the list of managed rule sets for the policy.

Variables: managed_rule_sets (list[ManagedRuleSet]) – List of rule sets.
Keyword Arguments: managed_rule_sets (list[ManagedRuleSet]) – List of rule sets.

class azure.mgmt.frontdoor.models.MatchCondition(*, match_variable: Union[str, _models.MatchVariable], operator: Union[str, _models.Operator], match_value: List[str], selector: Optional[str] = None, negate_condition: Optional[bool] = None, transforms: Optional[List[Union[str, _models.TransformType]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Define a match condition.

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

Variables

match_variable (str or MatchVariable) – Request variable to compare with. Required. Known values are: “RemoteAddr”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “Cookies”, and “SocketAddr”.
selector (str) – Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null.
operator (str or Operator) – Comparison type to use for matching with the variable value. Required. Known values are: “Any”, “IPMatch”, “GeoMatch”, “Equal”, “Contains”, “LessThan”, “GreaterThan”, “LessThanOrEqual”, “GreaterThanOrEqual”, “BeginsWith”, “EndsWith”, and “RegEx”.
negate_condition (bool) – Describes if the result of this condition should be negated.
match_value (list[str]) – List of possible match values. Required.
transforms (list[str or TransformType]) – List of transforms.

Keyword Arguments

match_variable (str or MatchVariable) – Request variable to compare with. Required. Known values are: “RemoteAddr”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestHeader”, “RequestBody”, “Cookies”, and “SocketAddr”.
selector (str) – Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null.
operator (str or Operator) – Comparison type to use for matching with the variable value. Required. Known values are: “Any”, “IPMatch”, “GeoMatch”, “Equal”, “Contains”, “LessThan”, “GreaterThan”, “LessThanOrEqual”, “GreaterThanOrEqual”, “BeginsWith”, “EndsWith”, and “RegEx”.
negate_condition (bool) – Describes if the result of this condition should be negated.
match_value (list[str]) – List of possible match values. Required.
transforms (list[str or TransformType]) – List of transforms.

class azure.mgmt.frontdoor.models.MatchProcessingBehavior(value)[source]¶

Bases: str, enum.Enum

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

CONTINUE = 'Continue'¶

STOP = 'Stop'¶

class azure.mgmt.frontdoor.models.MatchVariable(value)[source]¶

Bases: str, enum.Enum

Request variable to compare with.

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.MinimumTLSVersion(value)[source]¶

Bases: str, enum.Enum

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

ONE0 = '1.0'¶

ONE2 = '1.2'¶

class azure.mgmt.frontdoor.models.NetworkExperimentResourceState(value)[source]¶

Bases: str, enum.Enum

Defines the server side resource status.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

DISABLED = 'Disabled'¶

DISABLING = 'Disabling'¶

ENABLED = 'Enabled'¶

ENABLING = 'Enabling'¶

class azure.mgmt.frontdoor.models.NetworkOperationStatus(value)[source]¶

Bases: str, enum.Enum

Status of the Azure async operation.

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.frontdoor.models.Operator(value)[source]¶

Bases: str, enum.Enum

Comparison type to use for matching with the variable value.

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.PolicyEnabledState(value)[source]¶

Bases: str, enum.Enum

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

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.frontdoor.models.PolicyMode(value)[source]¶

Bases: str, enum.Enum

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

DETECTION = 'Detection'¶

PREVENTION = 'Prevention'¶

class azure.mgmt.frontdoor.models.PolicyRequestBodyCheck(value)[source]¶

Bases: str, enum.Enum

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

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.frontdoor.models.PolicyResourceState(value)[source]¶

Bases: str, enum.Enum

Resource status of the policy.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

DISABLED = 'Disabled'¶

DISABLING = 'Disabling'¶

ENABLED = 'Enabled'¶

ENABLING = 'Enabling'¶

class azure.mgmt.frontdoor.models.PolicySettings(*, enabled_state: Optional[Union[str, _models.PolicyEnabledState]] = None, mode: Optional[Union[str, _models.PolicyMode]] = None, redirect_url: Optional[str] = None, custom_block_response_status_code: Optional[int] = None, custom_block_response_body: Optional[str] = None, request_body_check: Optional[Union[str, _models.PolicyRequestBodyCheck]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Defines top-level WebApplicationFirewallPolicy configuration settings.

Variables

enabled_state (str or PolicyEnabledState) – Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. Known values are: “Disabled” and “Enabled”.
mode (str or PolicyMode) – Describes if it is in detection mode or prevention mode at policy level. Known values are: “Prevention” and “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.
request_body_check (str or PolicyRequestBodyCheck) – Describes if policy managed rules will inspect the request body content. Known values are: “Disabled” and “Enabled”.

Keyword Arguments

enabled_state (str or PolicyEnabledState) – Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. Known values are: “Disabled” and “Enabled”.
mode (str or PolicyMode) – Describes if it is in detection mode or prevention mode at policy level. Known values are: “Prevention” and “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.
request_body_check (str or PolicyRequestBodyCheck) – Describes if policy managed rules will inspect the request body content. Known values are: “Disabled” and “Enabled”.

class azure.mgmt.frontdoor.models.PreconfiguredEndpoint(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, description: Optional[str] = None, endpoint: Optional[str] = None, endpoint_type: Optional[Union[str, _models.EndpointType]] = None, backend: Optional[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.
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. Known values are: “AFD”, “AzureRegion”, “CDN”, and “ATM”.
backend (str) – The preconfigured endpoint backend.

Keyword Arguments

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. Known values are: “AFD”, “AzureRegion”, “CDN”, and “ATM”.
backend (str) – The preconfigured endpoint backend.

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

Bases: azure.mgmt.frontdoor._serialization.Model

Defines a list of preconfigured endpoints.

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

Variables

value (list[PreconfiguredEndpoint]) – List of PreconfiguredEndpoints supported by NetworkExperiment.
next_link (str) – URL to get the next set of PreconfiguredEndpoints if there are any.

Keyword Arguments

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

class azure.mgmt.frontdoor.models.PrivateEndpointStatus(value)[source]¶

Bases: str, enum.Enum

The Approval status for the connection to the Private Link.

APPROVED = 'Approved'¶

DISCONNECTED = 'Disconnected'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

TIMEOUT = 'Timeout'¶

class azure.mgmt.frontdoor.models.Profile(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, enabled_state: Optional[Union[str, _models.State]] = 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.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
etag (str) – Gets a unique read-only string that changes whenever the resource is updated.
resource_state (str or NetworkExperimentResourceState) – Resource status. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, and “Deleting”.
enabled_state (str or State) – The state of the Experiment. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
etag (str) – Gets a unique read-only string that changes whenever the resource is updated.
enabled_state (str or State) – The state of the Experiment. Known values are: “Enabled” and “Disabled”.

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

Bases: azure.mgmt.frontdoor._serialization.Model

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.

Variables

value (list[Profile]) – List of Profiles within a resource group.
next_link (str) – URL to get the next set of Profile objects if there are any.

Keyword Arguments

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

class azure.mgmt.frontdoor.models.ProfileUpdateModel(*, tags: Optional[Dict[str, str]] = None, enabled_state: Optional[Union[str, _models.State]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Defines modifiable attributes of a Profile.

Variables

tags (dict[str, str]) – Resource tags.
enabled_state (str or State) – The enabled state of the Profile. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

tags (dict[str, str]) – Resource tags.
enabled_state (str or State) – The enabled state of the Profile. Known values are: “Enabled” and “Disabled”.

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

Bases: azure.mgmt.frontdoor._serialization.Model

Parameters required for content purge.

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

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

class azure.mgmt.frontdoor.models.RedirectConfiguration(*, redirect_type: Optional[Union[str, _models.FrontDoorRedirectType]] = None, redirect_protocol: Optional[Union[str, _models.FrontDoorRedirectProtocol]] = None, custom_host: Optional[str] = None, custom_path: Optional[str] = None, custom_fragment: Optional[str] = None, custom_query_string: Optional[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.

Variables

odata_type (str) – Required.
redirect_type (str or FrontDoorRedirectType) – The redirect type the rule will use when redirecting traffic. Known values are: “Moved”, “Found”, “TemporaryRedirect”, and “PermanentRedirect”.
redirect_protocol (str or FrontDoorRedirectProtocol) – The protocol of the destination to where the traffic is redirected. Known values are: “HttpOnly”, “HttpsOnly”, and “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>`=:code:`<value> format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.

Keyword Arguments

redirect_type (str or FrontDoorRedirectType) – The redirect type the rule will use when redirecting traffic. Known values are: “Moved”, “Found”, “TemporaryRedirect”, and “PermanentRedirect”.
redirect_protocol (str or FrontDoorRedirectProtocol) – The protocol of the destination to where the traffic is redirected. Known values are: “HttpOnly”, “HttpsOnly”, and “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>`=:code:`<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: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._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.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.

Keyword Arguments

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

class azure.mgmt.frontdoor.models.ResourceType(value)[source]¶

Bases: str, enum.Enum

Type of Front Door resource used in CheckNameAvailability.

MICROSOFT_NETWORK_FRONT_DOORS = 'Microsoft.Network/frontDoors'¶

MICROSOFT_NETWORK_FRONT_DOORS_FRONTEND_ENDPOINTS = 'Microsoft.Network/frontDoors/frontendEndpoints'¶

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

Bases: azure.mgmt.frontdoor._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.

Variables: odata_type (str) – Required.

class azure.mgmt.frontdoor.models.RoutingRule(*, id: Optional[str] = None, name: Optional[str] = None, frontend_endpoints: Optional[List[_models.SubResource]] = None, accepted_protocols: Optional[List[Union[str, _models.FrontDoorProtocol]]] = None, patterns_to_match: Optional[List[str]] = None, enabled_state: Optional[Union[str, _models.RoutingRuleEnabledState]] = None, route_configuration: Optional[_models.RouteConfiguration] = None, rules_engine: Optional[_models.SubResource] = None, web_application_firewall_policy_link: Optional[_models.RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink] = 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.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
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’. Known values are: “Enabled” and “Disabled”.
route_configuration (RouteConfiguration) – A reference to the routing configuration.
rules_engine (SubResource) – A reference to a specific Rules Engine Configuration to apply to this route.
web_application_firewall_policy_link (RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for each routing rule (if applicable).
resource_state (str or FrontDoorResourceState) – Resource status. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.

Keyword Arguments

id (str) – Resource ID.
name (str) – Resource name.
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’. Known values are: “Enabled” and “Disabled”.
route_configuration (RouteConfiguration) – A reference to the routing configuration.
rules_engine (SubResource) – A reference to a specific Rules Engine Configuration to apply to this route.
web_application_firewall_policy_link (RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for each routing rule (if applicable).

class azure.mgmt.frontdoor.models.RoutingRuleEnabledState(value)[source]¶

Bases: str, enum.Enum

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

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

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

Bases: azure.mgmt.frontdoor._serialization.Model

Defines the Resource ID for a Routing Rule.

Variables: id (str) – Resource ID.
Keyword Arguments: id (str) – Resource ID.

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

Bases: azure.mgmt.frontdoor._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.
next_link (str) – URL to get the next set of RoutingRule objects if there are any.

Keyword Arguments

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

class azure.mgmt.frontdoor.models.RoutingRuleProperties(*, frontend_endpoints: Optional[List[_models.SubResource]] = None, accepted_protocols: Optional[List[Union[str, _models.FrontDoorProtocol]]] = None, patterns_to_match: Optional[List[str]] = None, enabled_state: Optional[Union[str, _models.RoutingRuleEnabledState]] = None, route_configuration: Optional[_models.RouteConfiguration] = None, rules_engine: Optional[_models.SubResource] = None, web_application_firewall_policy_link: Optional[_models.RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink] = None, **kwargs)[source]¶

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

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.

Variables

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’. Known values are: “Enabled” and “Disabled”.
route_configuration (RouteConfiguration) – A reference to the routing configuration.
rules_engine (SubResource) – A reference to a specific Rules Engine Configuration to apply to this route.
web_application_firewall_policy_link (RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for each routing rule (if applicable).
resource_state (str or FrontDoorResourceState) – Resource status. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.

Keyword Arguments

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’. Known values are: “Enabled” and “Disabled”.
route_configuration (RouteConfiguration) – A reference to the routing configuration.
rules_engine (SubResource) – A reference to a specific Rules Engine Configuration to apply to this route.
web_application_firewall_policy_link (RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for each routing rule (if applicable).

class azure.mgmt.frontdoor.models.RoutingRuleUpdateParameters(*, frontend_endpoints: Optional[List[_models.SubResource]] = None, accepted_protocols: Optional[List[Union[str, _models.FrontDoorProtocol]]] = None, patterns_to_match: Optional[List[str]] = None, enabled_state: Optional[Union[str, _models.RoutingRuleEnabledState]] = None, route_configuration: Optional[_models.RouteConfiguration] = None, rules_engine: Optional[_models.SubResource] = None, web_application_firewall_policy_link: Optional[_models.RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Routing rules to apply to an endpoint.

Variables

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’. Known values are: “Enabled” and “Disabled”.
route_configuration (RouteConfiguration) – A reference to the routing configuration.
rules_engine (SubResource) – A reference to a specific Rules Engine Configuration to apply to this route.
web_application_firewall_policy_link (RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for each routing rule (if applicable).

Keyword Arguments

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’. Known values are: “Enabled” and “Disabled”.
route_configuration (RouteConfiguration) – A reference to the routing configuration.
rules_engine (SubResource) – A reference to a specific Rules Engine Configuration to apply to this route.
web_application_firewall_policy_link (RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink) – Defines the Web Application Firewall policy for each routing rule (if applicable).

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

Bases: azure.mgmt.frontdoor._serialization.Model

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

Variables: id (str) – Resource ID.
Keyword Arguments: id (str) – Resource ID.

class azure.mgmt.frontdoor.models.RuleType(value)[source]¶

Bases: str, enum.Enum

Describes type of rule.

MATCH_RULE = 'MatchRule'¶

RATE_LIMIT_RULE = 'RateLimitRule'¶

class azure.mgmt.frontdoor.models.RulesEngine(*, rules: Optional[List[_models.RulesEngineRule]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

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.

Variables

name (str) – Resource name.
type (str) – Resource type.
id (str) – Resource ID.
rules (list[RulesEngineRule]) – A list of rules that define a particular Rules Engine Configuration.
resource_state (str or FrontDoorResourceState) – Resource status. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.

Keyword Arguments

rules (list[RulesEngineRule]) – A list of rules that define a particular Rules Engine Configuration.

class azure.mgmt.frontdoor.models.RulesEngineAction(*, request_header_actions: Optional[List[_models.HeaderAction]] = None, response_header_actions: Optional[List[_models.HeaderAction]] = None, route_configuration_override: Optional[_models.RouteConfiguration] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

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

Variables

request_header_actions (list[HeaderAction]) – A list of header actions to apply from the request from AFD to the origin.
response_header_actions (list[HeaderAction]) – A list of header actions to apply from the response from AFD to the client.
route_configuration_override (RouteConfiguration) – Override the route configuration.

Keyword Arguments

request_header_actions (list[HeaderAction]) – A list of header actions to apply from the request from AFD to the origin.
response_header_actions (list[HeaderAction]) – A list of header actions to apply from the response from AFD to the client.
route_configuration_override (RouteConfiguration) – Override the route configuration.

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

Bases: azure.mgmt.frontdoor._serialization.Model

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.

Variables

value (list[RulesEngine]) – List of rulesEngines within a Front Door.
next_link (str) – URL to get the next set of RulesEngine objects if there are any.

Keyword Arguments

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

class azure.mgmt.frontdoor.models.RulesEngineMatchCondition(*, rules_engine_match_variable: Union[str, _models.RulesEngineMatchVariable], rules_engine_operator: Union[str, _models.RulesEngineOperator], rules_engine_match_value: List[str], selector: Optional[str] = None, negate_condition: Optional[bool] = None, transforms: Optional[List[Union[str, _models.Transform]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Define a match condition.

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

Variables

rules_engine_match_variable (str or RulesEngineMatchVariable) – Match Variable. Required. Known values are: “IsMobile”, “RemoteAddr”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestPath”, “RequestFilename”, “RequestFilenameExtension”, “RequestHeader”, “RequestBody”, and “RequestScheme”.
selector (str) – Name of selector in RequestHeader or RequestBody to be matched.
rules_engine_operator (str or RulesEngineOperator) – Describes operator to apply to the match condition. Required. Known values are: “Any”, “IPMatch”, “GeoMatch”, “Equal”, “Contains”, “LessThan”, “GreaterThan”, “LessThanOrEqual”, “GreaterThanOrEqual”, “BeginsWith”, and “EndsWith”.
negate_condition (bool) – Describes if this is negate condition or not.
rules_engine_match_value (list[str]) – Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match. Required.
transforms (list[str or Transform]) – List of transforms.

Keyword Arguments

rules_engine_match_variable (str or RulesEngineMatchVariable) – Match Variable. Required. Known values are: “IsMobile”, “RemoteAddr”, “RequestMethod”, “QueryString”, “PostArgs”, “RequestUri”, “RequestPath”, “RequestFilename”, “RequestFilenameExtension”, “RequestHeader”, “RequestBody”, and “RequestScheme”.
selector (str) – Name of selector in RequestHeader or RequestBody to be matched.
rules_engine_operator (str or RulesEngineOperator) – Describes operator to apply to the match condition. Required. Known values are: “Any”, “IPMatch”, “GeoMatch”, “Equal”, “Contains”, “LessThan”, “GreaterThan”, “LessThanOrEqual”, “GreaterThanOrEqual”, “BeginsWith”, and “EndsWith”.
negate_condition (bool) – Describes if this is negate condition or not.
rules_engine_match_value (list[str]) – Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match. Required.
transforms (list[str or Transform]) – List of transforms.

class azure.mgmt.frontdoor.models.RulesEngineMatchVariable(value)[source]¶

Bases: str, enum.Enum

Match Variable.

IS_MOBILE = 'IsMobile'¶

POST_ARGS = 'PostArgs'¶

QUERY_STRING = 'QueryString'¶

REMOTE_ADDR = 'RemoteAddr'¶

REQUEST_BODY = 'RequestBody'¶

REQUEST_FILENAME = 'RequestFilename'¶

REQUEST_FILENAME_EXTENSION = 'RequestFilenameExtension'¶

REQUEST_HEADER = 'RequestHeader'¶

REQUEST_METHOD = 'RequestMethod'¶

REQUEST_PATH = 'RequestPath'¶

REQUEST_SCHEME = 'RequestScheme'¶

REQUEST_URI = 'RequestUri'¶

class azure.mgmt.frontdoor.models.RulesEngineOperator(value)[source]¶

Bases: str, enum.Enum

Describes operator to apply to the match condition.

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'¶

class azure.mgmt.frontdoor.models.RulesEngineProperties(*, rules: Optional[List[_models.RulesEngineRule]] = None, **kwargs)[source]¶

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

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.

Variables

rules (list[RulesEngineRule]) – A list of rules that define a particular Rules Engine Configuration.
resource_state (str or FrontDoorResourceState) – Resource status. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, “Deleting”, “Migrating”, and “Migrated”.

Keyword Arguments

rules (list[RulesEngineRule]) – A list of rules that define a particular Rules Engine Configuration.

class azure.mgmt.frontdoor.models.RulesEngineRule(*, name: str, priority: int, action: _models.RulesEngineAction, match_conditions: Optional[List[_models.RulesEngineMatchCondition]] = None, match_processing_behavior: Optional[Union[str, _models.MatchProcessingBehavior]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

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.

Variables

name (str) – A name to refer to this specific rule. Required.
priority (int) – A priority assigned to this rule. Required.
action (RulesEngineAction) – Actions to perform on the request and response if all of the match conditions are met. Required.
match_conditions (list[RulesEngineMatchCondition]) – A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.
match_processing_behavior (str or MatchProcessingBehavior) – If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: “Continue” and “Stop”.

Keyword Arguments

name (str) – A name to refer to this specific rule. Required.
priority (int) – A priority assigned to this rule. Required.
action (RulesEngineAction) – Actions to perform on the request and response if all of the match conditions are met. Required.
match_conditions (list[RulesEngineMatchCondition]) – A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.
match_processing_behavior (str or MatchProcessingBehavior) – If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: “Continue” and “Stop”.

class azure.mgmt.frontdoor.models.RulesEngineUpdateParameters(*, rules: Optional[List[_models.RulesEngineRule]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Rules Engine Configuration to apply to a Routing Rule.

Variables: rules (list[RulesEngineRule]) – A list of rules that define a particular Rules Engine Configuration.
Keyword Arguments: rules (list[RulesEngineRule]) – A list of rules that define a particular Rules Engine Configuration.

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

Bases: azure.mgmt.frontdoor._serialization.Model

Defines the Resource ID for a Security Policy.

Variables: id (str) – Resource ID.
Keyword Arguments: id (str) – Resource ID.

class azure.mgmt.frontdoor.models.SessionAffinityEnabledState(value)[source]¶

Bases: str, enum.Enum

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

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.frontdoor.models.Sku(*, name: Optional[Union[str, _models.SkuName]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

The pricing tier of the web application firewall policy.

Variables: name (str or SkuName) – Name of the pricing tier. Known values are: “Classic_AzureFrontDoor”, “Standard_AzureFrontDoor”, and “Premium_AzureFrontDoor”.
Keyword Arguments: name (str or SkuName) – Name of the pricing tier. Known values are: “Classic_AzureFrontDoor”, “Standard_AzureFrontDoor”, and “Premium_AzureFrontDoor”.

class azure.mgmt.frontdoor.models.SkuName(value)[source]¶

Bases: str, enum.Enum

Name of the pricing tier.

CLASSIC_AZURE_FRONT_DOOR = 'Classic_AzureFrontDoor'¶

PREMIUM_AZURE_FRONT_DOOR = 'Premium_AzureFrontDoor'¶

STANDARD_AZURE_FRONT_DOOR = 'Standard_AzureFrontDoor'¶

class azure.mgmt.frontdoor.models.State(value)[source]¶

Bases: str, enum.Enum

The state of the Experiment.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

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

Bases: azure.mgmt.frontdoor._serialization.Model

Reference to another subresource.

Variables: id (str) – Resource ID.
Keyword Arguments: id (str) – Resource ID.

class azure.mgmt.frontdoor.models.TagsObject(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.frontdoor._serialization.Model

Tags object for patch operations.

Variables: tags (dict[str, str]) – Resource tags.
Keyword Arguments: tags (dict[str, str]) – Resource tags.

class azure.mgmt.frontdoor.models.Timeseries(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, endpoint: Optional[str] = None, start_date_time_utc: Optional[str] = None, end_date_time_utc: Optional[str] = None, aggregation_interval: Optional[Union[str, _models.AggregationInterval]] = None, timeseries_type: Optional[Union[str, _models.TimeseriesType]] = None, country: Optional[str] = None, timeseries_data: Optional[List[_models.TimeseriesDataPoint]] = 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.
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. Known values are: “Hourly” and “Daily”.
timeseries_type (str or TimeseriesType) – The type of Timeseries. Known values are: “MeasurementCounts”, “LatencyP50”, “LatencyP75”, and “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.

Keyword Arguments

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. Known values are: “Hourly” and “Daily”.
timeseries_type (str or TimeseriesType) – The type of Timeseries. Known values are: “MeasurementCounts”, “LatencyP50”, “LatencyP75”, and “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.TimeseriesAggregationInterval(value)[source]¶

Bases: str, enum.Enum

TimeseriesAggregationInterval.

DAILY = 'Daily'¶

HOURLY = 'Hourly'¶

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

Bases: azure.mgmt.frontdoor._serialization.Model

Defines a timeseries datapoint used in a timeseries.

Variables

date_time_utc (str) – The DateTime of the Timeseries data point in UTC.
value (float) – The Value of the Timeseries data point.

Keyword Arguments

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.TimeseriesType(value)[source]¶

Bases: str, enum.Enum

The type of Timeseries.

LATENCY_P50 = 'LatencyP50'¶

LATENCY_P75 = 'LatencyP75'¶

LATENCY_P95 = 'LatencyP95'¶

MEASUREMENT_COUNTS = 'MeasurementCounts'¶

class azure.mgmt.frontdoor.models.Transform(value)[source]¶

Bases: str, enum.Enum

Describes what transforms are applied before matching.

LOWERCASE = 'Lowercase'¶

REMOVE_NULLS = 'RemoveNulls'¶

TRIM = 'Trim'¶

UPPERCASE = 'Uppercase'¶

URL_DECODE = 'UrlDecode'¶

URL_ENCODE = 'UrlEncode'¶

class azure.mgmt.frontdoor.models.TransformType(value)[source]¶

Bases: str, enum.Enum

Describes what transforms applied before matching.

LOWERCASE = 'Lowercase'¶

REMOVE_NULLS = 'RemoveNulls'¶

TRIM = 'Trim'¶

UPPERCASE = 'Uppercase'¶

URL_DECODE = 'UrlDecode'¶

URL_ENCODE = 'UrlEncode'¶

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

Bases: azure.mgmt.frontdoor._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.

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

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

Bases: azure.mgmt.frontdoor._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: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, sku: Optional[_models.Sku] = None, policy_settings: Optional[_models.PolicySettings] = None, custom_rules: Optional[_models.CustomRuleList] = None, managed_rules: Optional[_models.ManagedRuleSetList] = 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.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
etag (str) – Gets a unique read-only string that changes whenever the resource is updated.
sku (Sku) – The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified.
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.
frontend_endpoint_links (list[FrontendEndpointLink]) – Describes Frontend Endpoints associated with this Web Application Firewall policy.
routing_rule_links (list[RoutingRuleLink]) – Describes Routing Rules associated with this Web Application Firewall policy.
security_policy_links (list[SecurityPolicyLink]) – Describes Security Policy 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. Known values are: “Creating”, “Enabling”, “Enabled”, “Disabling”, “Disabled”, and “Deleting”.

Keyword Arguments

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
etag (str) – Gets a unique read-only string that changes whenever the resource is updated.
sku (Sku) – The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified.
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.

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

Bases: azure.mgmt.frontdoor._serialization.Model

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.

Variables

value (list[WebApplicationFirewallPolicy]) – List of WebApplicationFirewallPolicies within a resource group.
next_link (str) – URL to get the next set of WebApplicationFirewallPolicy objects if there are any.

Keyword Arguments

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