UrlRedirectActionParameters Class

Defines the parameters for the url redirect action.

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

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

Inheritance

Model

UrlRedirectActionParameters

Constructor

UrlRedirectActionParameters(*, redirect_type: Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.RedirectType], destination_protocol: Optional[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.DestinationProtocol]] = None, custom_path: Optional[str] = None, custom_hostname: Optional[str] = None, custom_query_string: Optional[str] = None, custom_fragment: Optional[str] = None, **kwargs)

Variables

type_name

str

Has constant value: "DeliveryRuleUrlRedirectActionParameters".

redirect_type

str or RedirectType

Required. The redirect type the rule will use when redirecting traffic. Possible values include: "Moved", "Found", "TemporaryRedirect", "PermanentRedirect".

destination_protocol

str or DestinationProtocol

Protocol to use for the redirect. The default value is MatchRequest. Possible values include: "MatchRequest", "Http", "Https".

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_hostname

str

Host to redirect. Leave empty to use the incoming host as the destination host.

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. ? and & will be added automatically so do not include them.

custom_fragment

str

Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.

Attributes

type_name

type_name = 'DeliveryRuleUrlRedirectActionParameters'