policies Package

Classes

AsyncBearerTokenCredentialPolicy

Adds a bearer token Authorization header to requests.

AsyncHTTPPolicy

An async HTTP policy ABC.

Use with an asynchronous pipeline.

AsyncRedirectPolicy

An async redirect policy.

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

AsyncRetryPolicy

Async flavor of the retry policy.

The async retry policy in the pipeline can be configured directly, or tweaked on a per-call basis.

AzureKeyCredentialPolicy

Adds a key header for the provided credential.

AzureSasCredentialPolicy

Adds a shared access signature to query for the provided credential.

BearerTokenCredentialPolicy

Adds a bearer token Authorization header to requests.

ContentDecodePolicy

Policy for decoding unstreamed response content.

CustomHookPolicy

A simple policy that enable the given callback with the response.

DistributedTracingPolicy

The policy to create spans for Azure calls.

HTTPPolicy

An HTTP policy ABC.

Use with a synchronous pipeline.

HeadersPolicy

A simple policy that sends the given headers with the request.

This will overwrite any headers already defined in the request. Headers can be configured up front, where any custom headers will be applied to all outgoing operations, and additional headers can also be added dynamically per operation.

HttpLoggingPolicy

The Pipeline policy that handles logging of HTTP requests and responses.

NetworkTraceLoggingPolicy

The logging policy in the pipeline is used to output HTTP network trace to the configured logger.

This accepts both global configuration, and per-request level with "enable_http_logger"

ProxyPolicy

A proxy policy.

Dictionary mapping protocol or protocol and host to the URL of the proxy to be used on each Request.

RedirectPolicy

A redirect policy.

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

RequestHistory

A container for an attempted request and the applicable response.

This is used to document requests/responses that resulted in redirected/retried requests.

RequestIdPolicy

A simple policy that sets the given request id in the header.

This will overwrite request id that is already defined in the request. Request id can be configured up front, where the request id will be applied to all outgoing operations, and additional request id can also be set dynamically per operation.

RetryPolicy

A retry policy.

The retry policy in the pipeline can be configured directly, or tweaked on a per-call basis.

SansIOHTTPPolicy

Represents a sans I/O policy.

SansIOHTTPPolicy is a base class for policies that only modify or mutate a request based on the HTTP specification, and do not depend on the specifics of any particular transport. SansIOHTTPPolicy subclasses will function in either a Pipeline or an AsyncPipeline, and can act either before the request is done, or after. You can optionally make these methods coroutines (or return awaitable objects) but they will then be tied to AsyncPipeline usage.

UserAgentPolicy

User-Agent Policy. Allows custom values to be added to the User-Agent header.

Enums

RetryMode

An enumeration.