Package version
The log levels supported by the logger. The log levels in order of most verbose to least verbose are:
Contains response data for the checkKeyValue operation.
Contains response data for the checkKeyValues operation.
Contains response data for the checkKeys operation.
Contains response data for the checkLabels operation.
Contains response data for the checkRevisions operation.
Standard base response for getting, deleting or updating a configuration setting
Contains response data for the deleteKeyValue operation.
Contains response data for the deleteLock operation.
Default type for functions
Contains response data for the getKeyValue operation.
Contains response data for the getKeyValues operation.
Contains response data for the getKeys operation.
Contains response data for the getLabels operation.
Contains response data for the getRevisions operation.
High resolution HrTime: [seconds: number, nanoseconds: number]
Copyright 2019, OpenCensus Authors
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Contains response data for the putKeyValue operation.
Contains response data for the putLock operation.
A HttpHeaders collection represented as a simple JSON object.
Creates a new RequestPolicy per-request that uses the provided nextPolicy.
Defines TimeInput.
hrtime, expoch milliseconds, performance.now() or Date
Tracestate carries system-specific configuration data, represented as a list of key-value pairs. TraceState allows multiple tracing systems to participate in the same trace.
Returns the value to which the specified key is mapped, or undefined if
this map contains no mapping for the key.
with which the specified value is to be associated.
the value to which the specified key is mapped, or undefined if
this map contains no mapping for the key.
Serializes the TraceState to a list as defined below. The list is a
series of list-members separated by commas ,, and a list-member is a
key/value pair separated by an equals sign =. Spaces and horizontal tabs
surrounding list-members are ignored. There can be a maximum of 32
list-members in a list.
the serialized string.
Adds or updates the TraceState that has the given key if it is
present. The new State will always be added in the front of the
list of states.
key of the TraceState entry.
value of the TraceState entry.
Removes the TraceState Entry that has the given key if it is present.
the key for the TraceState Entry to be removed.
Fired in response to upload or download progress.
The AzureLogger provides a mechanism for overriding where logs are output to.
By default, logs are sent to stderr.
Override the log method to redirect logs to another location.
Defines the default token refresh buffer duration.
A constant that indicates whether the environment is node.js or browser based.
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.
Creates a new BearerTokenAuthenticationPolicy factory.
The TokenCredential implementation that can supply the bearer token.
The scopes for which the bearer token applies.
Loads .env file contents into process.env.
Example: 'KEY=value' becomes { parsed: { KEY: 'value' } }
controls behavior
an object with a parsed key if successful or error key if an error occurred
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.
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
Generates a SpanContext given a traceparent header value.
The SpanContext generated from the traceparent value.
Generated UUID
RFC4122 v4 UUID.
Retrieves the currently specified log level.
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.
Generates a traceparent value given a span context.
Contains context for a specific span.
The spanContext represented as a traceparent value.
Retrieves the active tracer, or returns a no-op implementation if one is not set.
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
Tests an object to determine whether it implements TokenCredential.
The assumed TokenCredential to be tested.
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.
Makes a ConfigurationSetting-based response throw for all of the data members. Used primarily to prevent possible errors by the user in accessing a model that is uninitialized. This can happen in cases like HTTP status code 204 or 304, which return an empty response body.
The configuration setting to alter
Converts an OperationOptions to a RequestOptionsBase
OperationOptions object to convert to RequestOptionsBase
Parses a string or buffer in the .env file format into an object.
contents to be parsed
additional options
an object with keys and values based on src
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
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
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.
Immediately enables logging at the specified log level.
The log level to enable for logging. Options from most verbose to least verbose are:
Sets the global tracer, enabling tracing for the Azure SDK.
An OpenTelemetry Tracer instance.
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.
Checks if a parsed URL is HTTPS
The url to check
True if the URL is HTTPS; false otherwise.
Generated using TypeDoc
An AzureClientLogger is a function that can log to an appropriate severity level.