RouteUpdateParameters Class

The domain JSON object required for domain creation or update.

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

Inheritance

azure.mgmt.cdn._serialization.Model

RouteUpdateParameters

Constructor

RouteUpdateParameters(*, custom_domains: List[_models.ActivatedResourceReference] | None = None, origin_group: _models.ResourceReference | None = None, origin_path: str | None = None, rule_sets: List[_models.ResourceReference] | None = None, supported_protocols: List[str | _models.AFDEndpointProtocols] = ['Http', 'Https'], patterns_to_match: List[str] | None = None, cache_configuration: _models.AfdRouteCacheConfiguration | None = None, forwarding_protocol: str | _models.ForwardingProtocol | None = None, link_to_default_domain: str | _models.LinkToDefaultDomain = 'Disabled', https_redirect: str | _models.HttpsRedirect = 'Disabled', enabled_state: str | _models.EnabledState | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
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. Default value: ['Http', 'Https']
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. Known values are: "HttpOnly", "HttpsOnly", and "MatchRequest".
link_to_default_domain	str or LinkToDefaultDomain whether this route will be linked to the default endpoint domain. Known values are: "Enabled" and "Disabled". Default value: Disabled
https_redirect	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. Known values are: "Enabled" and "Disabled". Default value: Disabled
enabled_state	str or EnabledState Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled".

Variables

Name	Description
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. Known values are: "HttpOnly", "HttpsOnly", and "MatchRequest".
link_to_default_domain	str or LinkToDefaultDomain whether this route will be linked to the default endpoint domain. Known values are: "Enabled" and "Disabled".
https_redirect	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. Known values are: "Enabled" and "Disabled".
enabled_state	str or EnabledState Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled".