RouteUpdatePropertiesParameters Class

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

Constructor

RouteUpdatePropertiesParameters(*args: Any, **kwargs: Any)

Variables

Name Description
endpoint_name
str

The name of the endpoint which holds the route.

custom_domains

Domains referenced by this endpoint.

origin_group

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

rule sets referenced by this endpoint.

supported_protocols

List of supported protocols for this route.

patterns_to_match

The route patterns of the rule.

cache_configuration

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

forwarding_protocol

Protocol this rule will use when forwarding traffic to backends. Known values are: "HttpOnly", "HttpsOnly", and "MatchRequest".

link_to_default_domain

whether this route will be linked to the default endpoint domain. Known values are: "Enabled" and "Disabled".

https_redirect

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

enabled_state

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled".

Attributes

cache_configuration

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

cache_configuration: _models.AfdRouteCacheConfiguration | None

custom_domains

Domains referenced by this endpoint.

custom_domains: list['_models.ActivatedResourceReference'] | None

enabled_state

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled".

enabled_state: str | _models.EnabledState | None

endpoint_name

The name of the endpoint which holds the route.

endpoint_name: str | None

forwarding_protocol

Protocol this rule will use when forwarding traffic to backends. Known values are: "HttpOnly", "HttpsOnly", and "MatchRequest".

forwarding_protocol: str | _models.ForwardingProtocol | None

https_redirect

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

https_redirect: str | _models.HttpsRedirect | None

"Enabled" and "Disabled".

link_to_default_domain: str | _models.LinkToDefaultDomain | None

origin_group

A reference to the origin group.

origin_group: _models.ResourceReference | None

origin_path

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

origin_path: str | None

patterns_to_match

The route patterns of the rule.

patterns_to_match: list[str] | None

rule_sets

rule sets referenced by this endpoint.

rule_sets: list['_models.ResourceReference'] | None

supported_protocols

List of supported protocols for this route.

supported_protocols: list[typing.Union[str, ForwardRef('_models.AFDEndpointProtocols')]] | None