Class HttpPipelinePolicy

Represent an extension point for the HttpPipeline that can mutate the Request and react to received Response.

Inheritance

System.Object

HttpPipelinePolicy

BearerTokenAuthenticationPolicy

HttpPipelineSynchronousPolicy

RedirectPolicy

RetryPolicy

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Core.dll

Syntax

public abstract class HttpPipelinePolicy

Constructors

HttpPipelinePolicy()

Declaration

protected HttpPipelinePolicy ();

Methods

Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>)

Applies the policy to the message. Implementers are expected to mutate Request before calling ProcessNextAsync(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) and observe the Response changes after.

Declaration

public abstract void Process (Azure.Core.HttpMessage message, ReadOnlyMemory<Azure.Core.Pipeline.HttpPipelinePolicy> pipeline);

Parameters

HttpMessage message The HttpMessage this policy would be applied to.

System.ReadOnlyMemory<HttpPipelinePolicy> pipeline The set of HttpPipelinePolicy to execute after current one.

ProcessAsync(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>)

Applies the policy to the message. Implementers are expected to mutate Request before calling ProcessNextAsync(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) and observe the Response changes after.

Declaration

public abstract System.Threading.Tasks.ValueTask ProcessAsync (Azure.Core.HttpMessage message, ReadOnlyMemory<Azure.Core.Pipeline.HttpPipelinePolicy> pipeline);

Parameters

HttpMessage message The HttpMessage this policy would be applied to.

System.ReadOnlyMemory<HttpPipelinePolicy> pipeline The set of HttpPipelinePolicy to execute after current one.

Returns

System.Threading.Tasks.ValueTask The System.Threading.Tasks.ValueTask representing the asynchronous operation.

ProcessNext(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>)

Invokes the next HttpPipelinePolicy in the pipeline.

Declaration

protected static void ProcessNext (Azure.Core.HttpMessage message, ReadOnlyMemory<Azure.Core.Pipeline.HttpPipelinePolicy> pipeline);

Parameters

HttpMessage message The HttpMessage next policy would be applied to.

System.ReadOnlyMemory<HttpPipelinePolicy> pipeline The set of HttpPipelinePolicy to execute after next one.

ProcessNextAsync(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>)

Invokes the next HttpPipelinePolicy in the pipeline.

Declaration

protected static System.Threading.Tasks.ValueTask ProcessNextAsync (Azure.Core.HttpMessage message, ReadOnlyMemory<Azure.Core.Pipeline.HttpPipelinePolicy> pipeline);

Parameters

HttpMessage message The HttpMessage next policy would be applied to.

System.ReadOnlyMemory<HttpPipelinePolicy> pipeline The set of HttpPipelinePolicy to execute after next one.

Returns

System.Threading.Tasks.ValueTask The System.Threading.Tasks.ValueTask representing the asynchronous operation.