RouteProperties Class

The JSON object that contains the properties of the Routes to create.

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

Inheritance

azure.mgmt.cdn.models._models_py3.AFDStateProperties

RouteProperties

azure.mgmt.cdn.models._models_py3.RouteUpdatePropertiesParameters

RouteProperties

Constructor

RouteProperties(*, custom_domains: Optional[List[azure.mgmt.cdn.models._models_py3.ActivatedResourceReference]] = None, origin_group: Optional[azure.mgmt.cdn.models._models_py3.ResourceReference] = None, origin_path: Optional[str] = None, rule_sets: Optional[List[azure.mgmt.cdn.models._models_py3.ResourceReference]] = None, supported_protocols: Optional[List[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.AFDEndpointProtocols]]] = None, patterns_to_match: Optional[List[str]] = None, cache_configuration: Optional[azure.mgmt.cdn.models._models_py3.AfdRouteCacheConfiguration] = None, forwarding_protocol: Optional[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.ForwardingProtocol]] = None, link_to_default_domain: Optional[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.LinkToDefaultDomain]] = None, https_redirect: Optional[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.HttpsRedirect]] = None, enabled_state: Optional[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.EnabledState]] = None, **kwargs)

Variables

endpoint_name

str

The name of the endpoint which holds the route.

custom_domains

list[ActivatedResourceReference]

Domains referenced by this endpoint.

origin_group

ResourceReference

A reference to the origin group.

origin_path

str

A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.

rule_sets

list[ResourceReference]

rule sets referenced by this endpoint.

supported_protocols

list[str or AFDEndpointProtocols]

List of supported protocols for this route.

patterns_to_match

list[str]

The route patterns of the rule.

cache_configuration

AfdRouteCacheConfiguration

The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.

forwarding_protocol

str or ForwardingProtocol

Protocol this rule will use when forwarding traffic to backends. Possible values include: "HttpOnly", "HttpsOnly", "MatchRequest".

link_to_default_domain

str or LinkToDefaultDomain

whether this route will be linked to the default endpoint domain. Possible values include: "Enabled", "Disabled".

https_redirect

<xref:https_redirect>)<xref: >(str or HttpsRedirect

Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. Possible values include: "Enabled", "Disabled".

enabled_state

str or EnabledState

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Possible values include: "Enabled", "Disabled".

provisioning_state

str or AfdProvisioningState

Provisioning status. Possible values include: "Succeeded", "Failed", "Updating", "Deleting", "Creating".

deployment_status

str or DeploymentStatus

Possible values include: "NotStarted", "InProgress", "Succeeded", "Failed".