Package version
Creates a new RequestPolicy per-request that uses the provided nextPolicy.
Fired in response to upload or download progress.
The number of bytes loaded so far.
The Authorization header.
The Retry-After response-header field can be used with a 503 (Service Unavailable) or 349 (Too Many Requests) responses to indicate how long the service is expected to be unavailable to the requesting client.
The UserAgent header.
Defines the default token refresh buffer duration.
A constant that indicates whether the environment is node.js or browser based.
The automated token refresh will only start to happen at the expiration date minus the value of timeBetweenRefreshAttemptsInMs, which is by default 30 seconds.
Applies the properties on the prototype of sourceCtors to the prototype of targetCtor
The target object on which the properties need to be applied.
An array of source objects from which the properties need to be taken.
Get the Element-typed version of the provided Node if the provided node is an element with attributes. If it isn't, then undefined is returned.
Creates a new BearerTokenAuthenticationPolicy factory.
The TokenCredential implementation that can supply the bearer token.
The scopes for which the bearer token applies.
Validates the error code and message associated with 409 response status code. If it matches to that of RP not registered then it returns the name of the RP else returns undefined.
The response body received after making the original request.
The name of the RP if condition is satisfied else undefined.
Decodes a base64 string into a byte array.
the base64 string to decode
A wrapper for setTimeout that resolves a promise after t milliseconds.
The number of milliseconds to be delayed.
The value to be resolved with after a timeout of t milliseconds.
Resolved promise
Create a new serialization RequestPolicyCreator that will serialized HTTP request bodies as they pass through the HTTP pipeline.
Returns a request policy factory that can be used to create an instance of DisableResponseDecompressionPolicy.
Encodes a byte array in base64 format.
the Uint8Aray to encode
Encodes a string in base64 format.
the string to encode
Encodes an URI.
The URI to be encoded.
The encoded URI.
Executes an array of promises sequentially. Inspiration of this method is here: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. An awesome blog on promises!
An array of promise factories(A function that return a promise)
A chain of resolved or rejected promises
Extracts the first part of the URL, just after subscription: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/
The original request url
The url prefix as explained above.
Generated UUID
RFC4122 v4 UUID.
Get the character in the text string at the current index.
A collection of HttpHeaders that can be sent with a HTTP request.
Get the path to this parameter's value as a dotted string (a.b.c).
The parameter to get the path string for.
The path to this parameter's value as a dotted string.
Get the property parent for the property at the provided path when starting with the provided parent object.
Polls the registration status of the provider that was registered. Polling happens at an interval of 30 seconds. Polling will happen till the registrationState property of the response body is "Registered".
The RPRegistrationPolicy this function is being called against.
The request url for polling
The original request sent by the user that returned a 409 response with a message that the provider is not registered.
True if RP Registration is successful.
Reuses the headers of the original request and url (if specified).
The original request
Should the url from the original request be reused as well. Default false.
A new request object with desired headers.
Whether or not this URLTokenizer has a current character.
Get whether or not the provided character (single character string) is an alphanumeric (letter or digit) character.
Indicates whether the given string is in ISO 8601 format.
The value to be validated for ISO 8601 duration format.
true if valid, false otherwise.
Determines whether the given entity is a basic/primitive type (string, number, boolean, null, undefined).
Any entity
Validates the given uuid as a string
The uuid as a string that needs to be validated
True if the uuid is valid; false otherwise.
Advance to the character in text that is "step" characters ahead. If no step value is provided, then step will default to 1.
Converts an OperationOptions to a RequestOptionsBase
OperationOptions object to convert to RequestOptionsBase
Converts given XML string into JSON
String containing the XML content to be parsed into JSON
Options that govern the parsing of given xml string
includeRoot indicates whether the root element is to be included or not in the output
Starting with the current character, peek "charactersToPeek" number of characters ahead in this Tokenizer's stream of characters.
Converts a Promise to a callback.
The Promise to be converted to a callback
A function that takes the callback (cb: Function): void
Converts a Promise to a service callback.
The Promise of HttpOperationResponse to be converted to a service callback
A function that takes the service callback (cb: ServiceCallback
Read the remaining characters from this Tokenizer's character stream.
Read characters from this Tokenizer until one of the provided terminating characters is read or the end of the character stream is reached.
Read characters from this Tokenizer until the end of the stream or until the provided condition is false when provided the current character.
Read characters from this Tokenizer until a non-alphanumeric character or the end of the character stream is reached.
Registers the given provider.
The RPRegistrationPolicy this function is being called against.
The provider name to be registered.
The original request sent by the user that returned a 409 response with a message that the provider is not registered.
Replace all of the instances of searchValue in value with the provided replaceValue.
The value to search and replace in.
The value to search for in the value argument.
The value to replace searchValue with in the value argument.
The value where each instance of searchValue was replaced with replacedValue.
Resolves a composite mapper's modelProperties.
the serializer containing the entire set of mappers
the composite mapper to resolve
Specifies the max number of retries.
Initial chekck on whether to retry based on given responses or errors
The retry data.
True if the operation qualifies for a retry; false otherwise.
Utility function to create a K:V from a list of strings
Converts given JSON object to XML string
JSON object to be converted into XML string
Options that govern the parsing of given JSON object
rootName indicates the name of the root element in the resulting XML
Returns a stripped version of the Http Request that does not contain the Authorization header.
The Http Request object
The stripped version of Http Request.
Returns a stripped version of the Http Response which only contains body, headers and the status.
The Http Response
The stripped version of Http Response.
specifies retry interval, and its lower bound and upper bound.
Checks if a parsed URL is HTTPS
The url to check
True if the URL is HTTPS; false otherwise.
Specifies HTTP.
Specifies HTTPS.
Specifies HTTPS Proxy.
Specifies HTTP Proxy.
The core-http version
Defines constants for use with HTTP headers.
The Authorization header.
The Retry-After response-header field can be used with a 503 (Service Unavailable) or 349 (Too Many Requests) responses to indicate how long the service is expected to be unavailable to the requesting client.
The UserAgent header.
Http Verbs
Generated using TypeDoc
A HttpHeaders collection represented as a simple JSON object.