Package version
A simple object that provides form data, as if from a browser form.
Each form data entry can be a string or (in the browser) a Blob.
Supported HTTP methods to use when making requests.
Policies are executed in phases. The execution order is:
A HttpHeaders collection represented as a simple JSON object.
Types of bodies supported on the request. NodeJS.ReadableStream is Node only. Blob is browser only.
A simple interface for making a pipeline request and receiving a response.
Fired in response to upload or download progress.
The number of bytes loaded so far.
Defines the default token refresh buffer duration.
Methods that are allowed to follow redirects 301 and 302
The programmatic identifier of the bearerTokenAuthenticationPolicy.
The programmatic identifier of the decompressResponsePolicy.
The programmatic identifier of the exponentialRetryPolicy.
The programmatic identifier of the formDataPolicy. The programmatic identifier of the formDataPolicy.
The programmatic identifier of the logPolicy.
The programmatic identifier of the ndJsonPolicy.
The programmatic identifier of the proxyPolicy.
The programmatic identifier of the redirectPolicy.
The programmatic identifier of the setClientRequestIdPolicy.
The programmatic identifier of the systemErrorRetryPolicy.
The programmatic identifier of the throttlingRetryPolicy.
The programmatic identifier of the tracingPolicy.
The programmatic identifier of the userAgentPolicy.
A policy that can request a token from a TokenCredential implementation and then apply it to the Authorization header of a request as a Bearer token.
Converts an an unreliable access token getter (which may resolve with null) into an AccessTokenGetter by retrying the unreliable getter in a regular interval.
A function that produces a promise of an access token that may fail by returning null.
The time (in milliseconds) to wait between retry attempts.
The timestamp after which the refresh attempt will fail, throwing an exception.
Create the correct HttpClient for the current environment.
Creates a totally empty pipeline. Useful for testing or creating a custom one.
Creates an object that satisfies the HttpHeaders interface.
A simple object representing initial headers
Create a new pipeline with a default set of customizable policies.
Options to configure a custom pipeline.
Creates a new pipeline request with the given options. This method is to allow for the easy setting of default values and not required.
The options to create the request with.
Creates a token cycler from a credential, scopes, and optional settings.
A token cycler represents a way to reliably retrieve a valid access token from a TokenCredential. It will handle initializing the token, refreshing it when it nears expiration, and synchronizes refresh attempts to avoid concurrency hazards.
the underlying TokenCredential that provides the access token
optionally override default settings for the cycler
A policy to enable response decompression according to Accept-Encoding header https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
Default authorize request handler
A policy that attempts to retry requests while introducing an exponentially increasing delay.
Options that configure retry logic.
A policy that encodes FormData on the request into the body.
We will retrieve the challenge only if the response status code was 401, and if the response contained the header "WWW-Authenticate" with a non-empty value.
This method converts a proxy url into ProxySettings for use with ProxyPolicy.
If no argument is given, it attempts to parse a proxy URL from the environment
variables HTTPS_PROXY or HTTP_PROXY.
The url of the proxy to use. May contain authentication information.
A policy that logs all requests and responses.
Options to configure logPolicy.
ndJsonPolicy is a policy used to control keep alive settings for every request.
Returns the number of milliseconds to wait based on a Retry-After header value. Returns undefined if there is no valid value.
An HTTP Retry-After header value.
A policy that allows one to apply proxy settings to all requests. If not passed static settings, they will be retrieved from the HTTPS_PROXY or HTTP_PROXY environment variables.
ProxySettings to use on each request.
A policy to follow Location headers from the server in order to support server-side redirection.
Options to control policy behavior.
Each PipelineRequest gets a unique id upon creation. This policy passes that unique id along via an HTTP header to enable better telemetry and tracing.
The name of the header to pass the request ID to.
A retry policy that specifically seeks to handle errors in the underlying transport layer (e.g. DNS lookup failures) rather than retryable error codes from the server itself.
Options that customize the policy.
A policy that retries when the server sends a 429 response with a Retry-After header.
To learn more, please refer to https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits and https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
A simple policy to create OpenTelemetry Spans for each request made by the pipeline that has SpanOptions with a parent. Requests made without a parent Span will not be recorded.
Options to configure the telemetry logged by the tracing policy.
A policy that sets the User-Agent header (or equivalent) to reflect the library version.
Options to customize the user agent value.
Generated using TypeDoc
A function that gets a promise of an access token and allows providing options.
the options to pass to the underlying token provider