RedirectPolicy Class

A redirect policy.

A redirect policy in the pipeline can be configured directly or per operation.

Inheritance

azure.core.pipeline.policies._redirect.RedirectPolicyBase

RedirectPolicy

azure.core.pipeline.policies._base.HTTPPolicy

RedirectPolicy

Constructor

RedirectPolicy(**kwargs)

Parameters

permit_redirects

bool

Whether the client allows redirects. Defaults to True.

redirect_max

int

The maximum allowed redirects. Defaults to 30.

Examples

Configuring a redirect policy.

   from azure.core.pipeline.policies import RedirectPolicy

   redirect_policy = RedirectPolicy()

   # Client allows redirects. Defaults to True.
   redirect_policy.allow = True

   # The maximum allowed redirects. The default value is 30
   redirect_policy.max_redirects = 10

   # Alternatively you can disable redirects entirely
   redirect_policy = RedirectPolicy.no_redirects()

   # It can also be overridden per operation.
   client = PipelineClient(base_url=url, policies=[redirect_policy])
   request = client.get(url)
   pipeline_response = client._pipeline.run(request, permit_redirects=True, redirect_max=5)

Methods

send	Sends the PipelineRequest object to the next policy. Uses redirect settings to send request to redirect endpoint if necessary.

send

Sends the PipelineRequest object to the next policy. Uses redirect settings to send request to redirect endpoint if necessary.

send(request)

Parameters

request

PipelineRequest

Required

The PipelineRequest object

Returns

Returns the PipelineResponse or raises error if maximum redirects exceeded.

Return type

PipelineResponse

Exceptions

azure.core.exceptions.TooManyRedirectsError if maximum redirects exceeded.