Azure.Core
Represents an Azure service bearer access token with expiry information.
Creates a new instance of using the provided and .
The bearer access token value.
The bearer access token expiry date.
Get the access token value.
Gets the time when the provided token expires.
Indicates whether this instance and a specified object are equal.The object to compare with the current instance. if and this instance are the same type and represent the same value; otherwise, .
Returns the hash code for this instance.A 32-bit signed integer that is the hash code for this instance.
Base type for all client option types, exposes various common client options like , , .
Creates a new instance of .
The to be used for this client. Defaults to an instance of .
Gets the client diagnostic options.
Gets the client retry options.
Adds an policy into the client pipeline. The position of policy in the pipeline is controlled by parameter.
If you want the policy to execute once per client request use otherwise use
to run the policy for every retry. Note that the same instance of would be added to all pipelines of client constructed using this object.
The instance to be added to the pipeline.
The position of policy in the pipeline.
Determines whether the specified object is equal to the current object.The object to compare with the current object. if the specified object is equal to the current object; otherwise, .
Serves as the default hash function.A hash code for the current object.
Returns a string that represents the current object.A string that represents the current object.
A key which is used to encrypt, or wrap, another key.
The Id of the key used to perform cryptographic operations for the client.
Encrypts the specified key using the specified algorithm.
The key wrap algorithm used to encrypt the specified key.
The key to be encrypted.
A controlling the request lifetime.
The encrypted key bytes.
Encrypts the specified key using the specified algorithm.
The key wrap algorithm used to encrypt the specified key.
The key to be encrypted.
A controlling the request lifetime.
The encrypted key bytes.
Decrypts the specified encrypted key using the specified algorithm.
The key wrap algorithm which was used to encrypt the specified encrypted key.
The encrypted key to be decrypted.
A controlling the request lifetime.
The decrypted key bytes.
Decrypts the specified encrypted key using the specified algorithm.
The key wrap algorithm which was used to encrypt the specified encrypted key.
The encrypted key to be decrypted.
A controlling the request lifetime.
The decrypted key bytes.
An object capable of retrieving key encryption keys from a provided key identifier.
Retrieves the key encryption key corresponding to the specified keyId.
The key identifier of the key encryption key to retrieve.
A controlling the request lifetime.
The key encryption key corresponding to the specified keyId.
Retrieves the key encryption key corresponding to the specified keyId.
The key identifier of the key encryption key to retrieve.
A controlling the request lifetime.
The key encryption key corresponding to the specified keyId.
Exposes client options related to logging, telemetry and distributed tracing.
Get or sets value indicating whether HTTP pipeline logging is enabled.
Gets or sets value indicating whether distributed tracing spans are going to be created for this clients methods calls and HTTP calls.
Gets or sets value indicating whether the "User-Agent" header containing , client library package name and version,
and should be sent.
The default value can be controlled process wide by setting AZURE_TELEMETRY_DISABLED to true, false, 1 or 0.
Gets or sets value indicating if request or response content should be logged.
Gets or sets value indicating maximum size of content to log in bytes. Defaults to 4096.
Gets a list of headers names that are not redacted during logging.
Gets a list of query parameter names that are not redacted during logging.
Gets or sets the value sent a the first part of "User-Agent" headers for all requests issues by this client. Defaults to .
Gets or sets the default application id. Default application id would be set on all instances.
Implementation of that listens to events produces by Azure SDK Client libraries.
The trait name that has to be present on all event sources collected by this listener.
The trait value that has to be present on all event sources collected by this listener.
Creates an instance of that executes a callback every time event is written.
The to call when event is written. The second parameter is formatted message.
The level of events to enable.
Called for all existing event sources when the event listener is created and when a new event source is attached to the listener.The event source.
Called whenever an event has been written by an event source for which the event listener has enabled events.The event arguments that describe the event.
Creates a new instance of that forwards events to .
The level of events to enable.
Creates a new instance of that forwards events to .
The level of events to enable.
Marks the type exposing client registration options for clients registered with .
The type of the client.
The options type used by the client.
Abstraction for registering Azure clients in dependency injection containers.
Registers a client in the dependency injection container using the factory to create a client instance.
The type of the client.
The client options type used the client.
The factory, that given the instance of options, returns a client instance.
that allows customizing the client registration.
Abstraction for registering Azure clients in dependency injection containers and initializing them using IConfiguration objects.
Registers a client in the dependency injection container using the configuration to create a client instance.
The type of the client.
The client options type used the client.
Instance of to use.
that allows customizing the client registration.
Abstraction for registering Azure clients that require in dependency injection containers.
Registers a client in dependency injection container the using the factory to create a client instance.
The type of the client.
The client options type used the client.
The factory, that given the instance of options and credential, returns a client instance.
Specifies whether the credential is optional (client supports anonymous authentication).
that allows customizing the client registration.
Represents an HTTP header.
Creates a new instance of with provided name and value.
The header name.
The header value.
Gets header name.
Gets header value. If the header has multiple values they would be joined with a comma. To get separate values use or .
Returns the hash code for this instance.A 32-bit signed integer that is the hash code for this instance.
Indicates whether this instance and a specified object are equal.The object to compare with the current instance. if and this instance are the same type and represent the same value; otherwise, .
Returns the fully qualified type name of this instance.The fully qualified type name.
Indicates whether the current object is equal to another object of the same type.An object to compare with this object. if the current object is equal to the parameter; otherwise, .
Contains names of commonly used headers.
Returns. "Date"
Returns. "x-ms-date"
Returns. "Content-Type"
Returns. "Content-Length"
Returns. "ETag"
Returns. "x-ms-request-id"
Returns. "User-Agent"
Returns. "Accept"
Returns. "Authorization"
Returns. "Range"
Returns. "x-ms-range"
Returns. "If-Match"
Returns. "If-None-Match"
Returns. "If-Modified-Since"
Returns. "If-Unmodified-Since"
Returns. "Referer"
Returns. "Host"
Returns "Content-Disposition"
Commonly defined header values.
Returns header with name "ContentType" and value "application/json".
Returns header with name "Accept" and value "application/json".
Returns header with name "ContentType" and value "application/octet-stream".
Returns header with name "ContentType" and value "application/x-www-form-urlencoded".
Represents a context flowing through the .
Creates a new instance of .
The request.
The response classifier.
Gets the associated with this message.
Gets the associated with this message. Throws an exception if it wasn't set yet.
To avoid the exception use property to check.
Gets the value indicating if the response is set on this message.
The to be used during the processing.
The instance to use for response classification during pipeline invocation.
Gets or sets the value indicating if response would be buffered as part of the pipeline. Defaults to true.
Gets a property that modifies the pipeline behavior. Please refer to individual policies documentation on what properties it supports.
The property name.
The property value.
true if property exists, otherwise. false.
Sets a property that modifies the pipeline behavior. Please refer to individual policies documentation on what properties it supports.
The property name.
The property value.
Returns the response content stream and releases it ownership to the caller. After calling this methods using would result in exception.
The content stream or null if response didn't have any.
Disposes the request and response.
Represents a position of the policy in the pipeline.
The policy would be invoked once per pipeline invocation (service call).
The policy would be invoked every time request is retried.
A policy that sends an provided by a as an Authentication header.
Creates a new instance of using provided token credential and scope to authenticate for.
The token credential to use for authentication.
The scope to authenticate for.
Creates a new instance of using provided token credential and scopes to authenticate for.
The token credential to use for authentication.
Scopes to authenticate for.
Applies the policy to the . Implementers are expected to mutate before calling and observe the changes after.
The this policy would be applied to.
The set of to execute after current one.
The representing the asynchronous operation.
Applies the policy to the . Implementers are expected to mutate before calling and observe the changes after.
The this policy would be applied to.
The set of to execute after current one.
An implementation that uses as the transport.
Creates a new instance using default configuration.
Creates a new instance of using the provided client instance.
The instance of to use.
Creates a new instance of using the provided client instance.
The instance of to use.
A shared instance of with default parameters.
Creates a new transport specific instance of . This should not be called directly, or
should be used instead.
Sends the request contained by the and sets the property to received response synchronously.
The containing request and response.
Sends the request contained by the and sets the property to received response asynchronously.
The containing request and response.
Represents a primitive for sending HTTP requests and receiving responses extensible by adding processing steps.
Creates a new instance of with the provided transport, policies and response classifier.
The to use for sending the requests.
Policies to be invoked as part of the pipeline in order.
The response classifier to be used in invocations.
Creates a new instance.
The request.
Creates a new instance.
The message.
The instance used in this pipeline invocations.
Invokes the pipeline asynchronously. After the task completes response would be set to the property.
The to send.
The to use.
The representing the asynchronous operation.
Invokes the pipeline synchronously. After the task completes response would be set to the property.
The to send.
The to use.
Invokes the pipeline asynchronously with the provided request.
The to send.
The to use.
The representing the asynchronous operation.
Invokes the pipeline synchronously with the provided request.
The to send.
The to use.
The from the server.
Creates a scope in which all outgoing requests would use the provided
The client request id value to be sent with request.
The instance that needs to be disposed when client request id shouldn't be sent anymore.
Sample usage:
var secretClient = new SecretClient(new Uri("http://example.com"), new DefaultAzureCredential());
using (HttpPipeline.CreateClientRequestIdScope("<custom-client-request-id>"))
{
// The HTTP request resulting from the client call would have x-ms-client-request-id value set to <custom-client-request-id>
secretClient.GetSecret("<secret-name>");
}
Factory for creating instances of populated with default policies.
Creates an instance of populated with default policies, customer provided policies from and client provided per call policies.
The customer provided client options object.
Client provided per-retry policies.
A new instance of
Creates an instance of populated with default policies, customer provided policies from and client provided per call policies.
The customer provided client options object.
Client provided per-call policies.
Client provided per-retry policies.
The client provided response classifier.
A new instance of
Represent an extension point for the that can mutate the and react to received .
Applies the policy to the . Implementers are expected to mutate before calling and observe the changes after.
The this policy would be applied to.
The set of to execute after current one.
The representing the asynchronous operation.
Applies the policy to the . Implementers are expected to mutate before calling and observe the changes after.
The this policy would be applied to.
The set of to execute after current one.
Invokes the next in the .
The next policy would be applied to.
The set of to execute after next one.
The representing the asynchronous operation.
Invokes the next in the .
The next policy would be applied to.
The set of to execute after next one.
Represents a that doesn't do any asynchronous or synchronously blocking operations.
Applies the policy to the . Implementers are expected to mutate before calling and observe the changes after.
The this policy would be applied to.
The set of to execute after current one.
Applies the policy to the . Implementers are expected to mutate before calling and observe the changes after.
The this policy would be applied to.
The set of to execute after current one.
The representing the asynchronous operation.
Method is invoked before the request is sent.
The containing the request.
Method is invoked after the response is received.
The containing the response.
Represents an HTTP pipeline transport used to send HTTP requests and receive responses.
Sends the request contained by the and sets the property to received response synchronously.
The containing request and response.
Sends the request contained by the and sets the property to received response asynchronously.
The containing request and response.
Creates a new transport specific instance of . This should not be called directly, or
should be used instead.
The based implementation.
Creates a new instance of
Sends the request contained by the and sets the property to received response synchronously.
The containing request and response.
Sends the request contained by the and sets the property to received response asynchronously.
The containing request and response.
Creates a new transport specific instance of . This should not be called directly, or
should be used instead.
Gets the proxy URI. (iWebProxy interface).
Checks if URI is subject to proxy or not.
Read-only Stream that will throw a if it has to wait longer than a configurable timeout to read more data
Pipeline policy to buffer response content or add a timeout to response content managed by the client
HACK HACK HACK. Some runtime environments like Azure.Functions downgrade System.Diagnostic.DiagnosticSource package version causing method not found exceptions in customer apps
This type is a temporary workaround to avoid the issue.
Both and are defined as public structs so that foreach can use duck typing
to call and avoid heap memory allocation.
Please don't delete this method and don't make these types private.
Represents an HTTP request. Use or to create an instance.
Gets or sets and instance of used to create the Uri.
Gets or sets the request HTTP method.
Gets or sets the request content.
Adds a header value to the header collection.
The header name.
The header value.
Returns header value if the header is stored in the collection. If the header has multiple values they are going to be joined with a comma.
The header name.
The reference to populate with value.
true if the specified header is stored in the collection, otherwise false.
Returns header values if the header is stored in the collection.
The header name.
The reference to populate with values.
true if the specified header is stored in the collection, otherwise false.
Returns true if the header is stored in the collection.
The header name.
true if the specified header is stored in the collection, otherwise false.
Sets a header value the header collection.
The header name.
The header value.
Removes the header from the collection.
The header name.
Returns an iterator enumerating in the request.
The enumerating in the response.
Gets or sets the client request id that was sent to the server as x-ms-client-request-id headers.
Gets the response HTTP headers.
Frees resources held by this instance.
Represents the content sent as part of the .
Creates an instance of that wraps a .
The to use.
An instance of that wraps a .
Creates an instance of that wraps an of .
The of to use.
An instance of that wraps provided of .
Creates an instance of that wraps an of .
The of to use.
The offset in to start from.
The length of the segment to use.
An instance of that wraps provided of .
Creates an instance of that wraps a .
The to use.
An instance of that wraps a .
Creates an instance of that wraps a .
The to use.
An instance of that wraps a .
Writes contents of this object to an instance of .
The stream to write to.
To cancellation token to use.
Writes contents of this object to an instance of .
The stream to write to.
To cancellation token to use.
Attempts to compute the length of the underlying content, if available.
The length of the underlying data.
Frees resources held by the object.
Headers to be sent as part of the .
Returns an enumerator that iterates through the .
A for the .
Returns an enumerator that iterates through the .
A for the .
Adds the instance to the collection.
The header to add.
Adds the header to the collection. If a header with this name already exist adds an additional value to the header values.
The header name.
The header value.
Returns header value if the headers is stored in the collection. If the header has multiple values they are going to be joined with a comma.
The header name.
The reference to populate with value.
true if the specified header is stored in the collection, otherwise false.
Returns header values if the header is stored in the collection.
The header name.
The reference to populate with values.
true if the specified header is stored in the collection, otherwise false.
Returns true if the headers is stored in the collection.
The header name.
true if the specified header is stored in the collection, otherwise false.
Sets the header value name. If a header with this name already exist replaces it's value.
The header name.
The header value.
Removes the header from the collection.
The header name.
true if the header existed, otherwise false.
Represents HTTP methods sent as part of a .
Gets the HTTP method.
Gets instance for GET method.
Gets instance for POST method.
Gets instance for PUT method.
Gets instance for PATCH method.
Gets instance for DELETE method.
Gets instance for HEAD method.
Gets instance for OPTIONS method.
Gets instance for TRACE method.
Creates an instance of with provided method. Method must be all uppercase.
Prefer if can be one of predefined method names.
The method to use.
Parses string to it's representation.
The method string to parse.
Indicates whether the current object is equal to another object of the same type.An object to compare with this object. if the current object is equal to the parameter; otherwise, .
Indicates whether this instance and a specified object are equal.The object to compare with the current instance. if and this instance are the same type and represent the same value; otherwise, .
Returns the hash code for this instance.A 32-bit signed integer that is the hash code for this instance.
Compares equality of two instances.
The method to compare.
The method to compare against.
true if values are equal for and , otherwise false.
Compares inequality of two instances.
The method to compare.
The method to compare against.
true if values are equal for and , otherwise false.
Returns the fully qualified type name of this instance.The fully qualified type name.
Provides a custom builder for Uniform Resource Identifiers (URIs) and modifies URIs for the class.
Gets or sets the scheme name of the URI.
Gets or sets the Domain Name System (DNS) host name or IP address of a server.
Gets or sets the port number of the URI.
Gets or sets any query information included in the URI.
Gets or sets the path to the resource referenced by the URI.
Gets the path and query string to the resource referenced by the URI.
Replaces values inside this instance with values provided in the parameter.
The instance to get values from.
Gets the instance constructed by the specified instance.
A that contains the URI constructed by the .
Appends a query parameter adding separator if required. Escapes the value.
The name of parameter.
The value of parameter.
Appends a query parameter adding separator if required.
The name of parameter.
The value of parameter.
Whether value should be escaped.
Escapes and appends the to without adding path separator.
Path segments and any other characters will be escaped, e.g. "/" will be escaped as "%3a".
The value to escape and append.
Optionally escapes and appends the to without adding path separator.
If is true, path segments and any other characters will be escaped, e.g. "/" will be escaped as "%3a".
The value to optionally escape and append.
Whether value should be escaped.
Returns a string representation of this .
A string representation of this .
A type that analyzes HTTP responses and exceptions and determines if they should be retried.
Specifies if the request contained in the should be retried.
Specifies if the operation that caused the exception should be retried.
Specifies if the operation that caused the exception should be retried taking the into consideration.
Specifies if the response contained in the is not successful.
Headers received as part of the .
Gets the parsed value of "Date" or "x-ms-date" header.
Gets the value of "Content-Type" header.
Gets the parsed value of "Content-Length" header.
Gets the parsed value of "ETag" header.
Gets the value of "x-ms-request-id" header.
Returns an enumerator that iterates through the .
A for the .
Returns an enumerator that iterates through the .
A for the .
Returns header value if the header is stored in the collection. If header has multiple values they are going to be joined with a comma.
The header name.
The reference to populate with value.
true if the specified header is stored in the collection, otherwise false.
Returns header values if the header is stored in the collection.
The header name.
The reference to populate with values.
true if the specified header is stored in the collection, otherwise false.
Returns true if the header is stored in the collection.
The header name.
true if the specified header is stored in the collection, otherwise false.
The type of approach to apply when calculating the delay
between retry attempts.
Retry attempts happen at fixed intervals; each delay is a consistent duration.
Retry attempts will delay based on a backoff strategy, where each attempt will increase
the duration that it waits before retrying.
The set of options that can be specified to influence how
retry attempts are made, and a failure is eligible to be retried.
The maximum number of retry attempts before giving up.
The delay between retry attempts for a fixed approach or the delay
on which to base calculations for a backoff-based approach.
The maximum permissible delay between retry attempts.
The approach to use for calculating retry delays.
The timeout applied to an individual network operations.
Converts type member names to serializable member names.
Converts a to a serializable member name.
The to convert to a serializable member name.
The serializable member name, or null if the member is not defined or ignored by the serializer.
is null.
A implementation that uses to for serialization/deserialization.
Initializes new instance of .
Initializes new instance of .
The instance to use when serializing/deserializing.
is null.
Convert the provided value to it's binary representation and write it to .
The to write to.
The value to convert.
The type of the to convert.
The to use during serialization.
Convert the provided value to it's binary representation and write it to .
The to write to.
The value to convert.
The type of the to convert.
The to use during serialization.
Read the binary representation into a .
The Stream will be read to completion.
The to read from.
The type of the object to convert to and return.
The to use during deserialization.
Read the binary representation into a .
The Stream will be read to completion.
The to read from.
The type of the object to convert to and return.
The to use during deserialization.
Converts a to a serializable member name.
The to convert to a serializable member name.
The serializable member name, or null if the member is not defined or ignored by the serializer.
is null.
An abstraction for reading typed objects.
Convert the provided value to it's binary representation and write it to .
The to write to.
The value to convert.
The type of the to convert.
The to use during serialization.
Convert the provided value to it's binary representation and write it to .
The to write to.
The value to convert.
The type of the to convert.
The to use during serialization.
Read the binary representation into a .
The Stream will be read to completion.
The to read from.
The type of the object to convert to and return.
The to use during deserialization.
Read the binary representation into a .
The Stream will be read to completion.
The to read from.
The type of the object to convert to and return.
The to use during deserialization.
Represents a credential capable of providing an OAuth token.
Gets an for the specified set of scopes.
The with authentication information.
The to use.
A valid .
Gets an for the specified set of scopes.
The with authentication information.
The to use.
A valid .
Contains the details of an authentication token request.
Creates a new TokenRequest with the specified scopes.
The scopes required for the token.
The of the request requiring a token for authentication, if applicable.
The scopes required for the token.
The of the request requiring a token for authentication, if applicable.
Argument validation.
This class should be shared via source using Azure.Core.props and contain only common argument validation.
It is declared partial so that you can use the same familiar class name but extend it with project-specific validation.
To extend the functionality of this class, just declare your own partial class with project-specific methods.
Be sure to document exceptions thrown by these methods on your public methods.
Throws if is null.
The value to validate.
The name of the parameter.
is null.
Throws if has not been initialized.
The value to validate.
The name of the parameter.
has not been initialized.
Throws if is null or an empty collection.
The value to validate.
The name of the parameter.
is an empty collection.
is null.
Throws if is null or an empty string.
The value to validate.
The name of the parameter.
is an empty string.
is null.
Throws if is null, an empty string, or consists only of white-space characters.
The value to validate.
The name of the parameter.
is an empty string or consists only of white-space characters.
is null.
Throws if is the default value for type .
The type of structure to validate which implements .
The value to validate.
The name of the parameter.
is the default value for type .
Throws if is less than the or greater than the .
The type of to validate which implements .
The value to validate.
The minimum value to compare.
The maximum value to compare.
The name of the parameter.
Initializes a new instance of the class.
The used to authenticate requests.
The name of the key header used for the credential.
Method is invoked before the request is sent.
The containing the request.
Initializes a new instance of the class.
The used to authenticate requests.
Method is invoked before the request is sent.
The containing the request.
Converts a Base64URL encoded string to a string.
The Base64Url encoded string containing UTF8 bytes for a string.
The string represented by the Base64URL encoded string.
Encode a byte array as a Base64URL encoded string.
Raw byte input buffer.
The bytes, encoded as a Base64URL string.
Converts a Base64URL encoded string to a string.
The Base64Url encoded string containing UTF8 bytes for a string.
The string represented by the Base64URL encoded string.
Encode a string as a Base64URL encoded string.
String input buffer.
The UTF8 bytes for the string, encoded as a Base64URL string.
Copied from https://github.com/dotnet/corefx/blob/master/src/Common/src/CoreLib/System/HashCode.cs.
A collection of values that may take multiple service requests to
iterate over.
The type of the values.
Example of enumerating an AsyncPageable using the async foreach loop:
// call a service method, which returns AsyncPageable<T>
AsyncPageable<SecretProperties> allSecretProperties = client.GetPropertiesOfSecretsAsync();
await foreach (SecretProperties secretProperties in allSecretProperties)
{
Console.WriteLine(secretProperties.Name);
}
or using a while loop:
// call a service method, which returns AsyncPageable<T>
AsyncPageable<SecretProperties> allSecretProperties = client.GetPropertiesOfSecretsAsync();
IAsyncEnumerator<SecretProperties> enumerator = allSecretProperties.GetAsyncEnumerator();
try
{
while (await enumerator.MoveNextAsync())
{
SecretProperties secretProperties = enumerator.Current;
Console.WriteLine(secretProperties.Name);
}
}
finally
{
await enumerator.DisposeAsync();
}
Gets a used for requests made while
enumerating asynchronously.
Initializes a new instance of the
class for mocking.
Initializes a new instance of the
class.
The used for requests made while
enumerating asynchronously.
Enumerate the values a at a time. This may
make multiple service requests.
A continuation token indicating where to resume paging or null to
begin paging from the beginning.
The size of s that should be requested (from
service operations that support it).
An async sequence of s.
Enumerate the values in the collection asynchronously. This may
make multiple service requests.
The used for requests made while
enumerating asynchronously.
An async sequence of values.
Creates an instance of using the provided pages.
The pages of values to list as part of net new pageable instance.
A new instance of
Creates a string representation of an .
A string representation of an .
Check if two instances are equal.
The instance to compare to.
True if they're equal, false otherwise.
Get a hash code for the .
Hash code for the .
Key credential used to authenticate to an Azure Service.
It provides the ability to update the key without creating a new client.
Key used to authenticate to an Azure service.
Initializes a new instance of the class.
Key to use to authenticate with the Azure service.
Thrown when the is null.
Thrown when the is empty.
Updates the service key.
This is intended to be used when you've regenerated your service key
and want to update long lived clients.
Key to authenticate the service against.
Thrown when the is null.
Thrown when the is empty.
Shared access signature credential used to authenticate to an Azure Service.
It provides the ability to update the shared access signature without creating a new client.
Shared access signature used to authenticate to an Azure service.
Initializes a new instance of the class.
Shared access signature to use to authenticate with the Azure service.
Thrown when the is null.
Thrown when the is empty.
Updates the shared access signature.
This is intended to be used when you've regenerated your shared access signature
and want to update long lived clients.
Shared access signature to authenticate the service against.
Thrown when the is null.
Thrown when the is empty.
Represents an HTTP ETag.
Creates a new instance of .
The string value of the ETag.
Compares equality of two instances.
The to compare.
The to compare to.
true if values of both ETags are equal, otherwise false.
Compares inequality of two instances.
The to compare.
The to compare to.
true if values of both ETags are not equal, otherwise false.
Instance of with the value. *
Indicates whether the current object is equal to another object of the same type.An object to compare with this object. if the current object is equal to the parameter; otherwise, .
Indicates whether the value of current is equal to the provided string.
An object to compare with this object.
true if the current object is equal to the other parameter; otherwise, false.
Indicates whether this instance and a specified object are equal.The object to compare with the current instance. if and this instance are the same type and represent the same value; otherwise, .
Returns the hash code for this instance.A 32-bit signed integer that is the hash code for this instance.
The string representation of this .
Returns the string representation of the .
A format string. Valid values are "G" for standard format and "H" for header format.
The formatted string representation of this . This includes outer quotes and the W/ prefix in the case of weak ETags.
ETag tag = ETag.Parse("\"sometag\"");
Console.WriteLine(tag.ToString("G"));
// Displays: sometag
Console.WriteLine(tag.ToString("H"));
// Displays: "sometag"
Defines a range of bytes within an HTTP resource, starting at an offset and
ending at offset+count-1 inclusively.
Gets the starting offset of the .
Gets the size of the . null means the range
extends all the way to the end.
Creates an instance of HttpRange.
The starting offset of the . Defaults to 0.
The length of the range. null means to the end.
Converts the specified range to a string.
String representation of the range.
For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations.
Check if two instances are equal.
The first instance to compare.
The second instance to compare.
True if they're equal, false otherwise.
Check if two instances are not equal.
The first instance to compare.
The second instance to compare.
True if they're not equal, false otherwise.
Check if two instances are equal.
The instance to compare to.
True if they're equal, false otherwise.
Check if two instances are equal.
The instance to compare to.
True if they're equal, false otherwise.
Get a hash code for the .
Hash code for the .
Represents a JSON Patch document.
Initializes a new instance of that uses as the default serializer.
Initializes a new instance of
The instance to use for value serialization.
Initializes a new instance of
The binary representation of JSON Patch document.
Initializes a new instance of using an existing UTF8-encoded JSON Patch document.
The binary representation of JSON Patch document.
The instance to use for value serialization.
Initializes a new instance of using an existing UTF8-encoded JSON Patch document.
The path to apply the addition to.
The raw JSON value to add to the path.
Appends an "add" operation to this .
The path to apply the addition to.
The value to add to the path.
Appends a "replace" operation to this .
The path to replace.
The raw JSON value to replace with.
Appends a "replace" operation to this .
The path to replace.
The value to replace with.
Appends a "copy" operation to this .
The path to copy from.
The path to copy to.
Appends a "move" operation to this .
The path to move from.
The path to move to.
Appends a "remove" operation to this .
The path to remove.
Appends a "test" operation to this .
The path to test.
The raw JSON value to test against.
Appends a "test" operation to this .
The path to test.
The value to replace with.
Returns a UTF8-encoded representation of this instance.
The UTF8-encoded JSON.
Returns a formatted JSON string representation of this .
A formatted JSON string representation of this .
Specifies HTTP options for conditional requests.
Optionally limit requests to resources that have a matching ETag.
Optionally limit requests to resources that do not match the ETag.
Represents a long-running operation.
The final result of the long-running operation.
Gets an ID representing the operation that can be used to poll for
the status of the long-running operation.
Final result of the long-running operation.
This property can be accessed only after the operation completes successfully (HasValue is true).
The last HTTP response received from the server.
The last response returned from the server during the lifecycle of this instance.
An instance of Operation sends requests to a server in UpdateStatusAsync, UpdateStatus, and other methods.
Responses from these requests can be accessed using GetRawResponse.
Returns true if the long-running operation completed.
Returns true if the long-running operation completed successfully and has produced final result (accessible by Value property).
Periodically calls the server till the long-running operation completes.
A used for the periodical service calls.
The last HTTP response received from the server.
This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final result of the operation.
Periodically calls the server till the long-running operation completes.
The interval between status requests to the server.
The interval can change based on information returned from the server.
For example, the server might communicate to the client that there is not reason to poll for status change sooner than some time.
A used for the periodical service calls.
The last HTTP response received from the server.
This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final result of the operation.
Calls the server to get updated status of the long-running operation.
A used for the service call.
The HTTP response received from the server.
This operation will update the value returned from GetRawResponse and might update HasCompleted, HasValue, and Value.
Calls the server to get updated status of the long-running operation.
A used for the service call.
The HTTP response received from the server.
This operation will update the value returned from GetRawResponse and might update HasCompleted, HasValue, and Value.
Determines whether the specified object is equal to the current object.The object to compare with the current object. if the specified object is equal to the current object; otherwise, .
Serves as the default hash function.A hash code for the current object.
Returns a string that represents the current object.A string that represents the current object.
A single of values from a request that may return
zero or more s of values.
The type of values.
Gets the values in this .
Gets the continuation token used to request the next
. The continuation token may be null or
empty when there are no more pages.
Gets the that provided this
.
Creates a new .
The values in this .
The continuation token used to request the next .
The that provided this .
Creates a string representation of an .
A string representation of an .
Check if two instances are equal.
The instance to compare to.
True if they're equal, false otherwise.
Get a hash code for the .
Hash code for the .
A collection of values that may take multiple service requests to
iterate over.
The type of the values.
Gets a used for requests made while
enumerating asynchronously.
Initializes a new instance of the
class for mocking.
Initializes a new instance of the
class.
The used for requests made while
enumerating asynchronously.
Enumerate the values a at a time. This may
make multiple service requests.
A continuation token indicating where to resume paging or null to
begin paging from the beginning.
The size of s that should be requested (from
service operations that support it).
An async sequence of s.
Creates a string representation of an .
A string representation of an .
Enumerate the values in the collection. This may make multiple service requests.
Creates an instance of using the provided pages.
The pages of values to list as part of net new pageable instance.
A new instance of
Check if two instances are equal.
The instance to compare to.
True if they're equal, false otherwise.
Get a hash code for the .
Hash code for the .
Specifies HTTP options for conditional requests based on modification time.
Optionally limit requests to resources that have only been
modified since this point in time.
Optionally limit requests to resources that have remained
unmodified.
An exception thrown when service request fails.
Gets the HTTP status code of the response. Returns. 0 if response was not received.
Gets the service specific error code if available. Please refer to the client documentation for the list of supported error codes.
Initializes a new instance of the class with a specified error message.
The message that describes the error.
Initializes a new instance of the class with a specified error message, HTTP status code and a reference to the inner exception that is the cause of this exception.
The error message that explains the reason for the exception.
The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.
Initializes a new instance of the class with a specified error message and HTTP status code.
The HTTP status code, or 0 if not available.
The message that describes the error.
Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception.
The HTTP status code, or 0 if not available.
The error message that explains the reason for the exception.
The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.
Initializes a new instance of the class with a specified error message, HTTP status code, error code, and a reference to the inner exception that is the cause of this exception.
The HTTP status code, or 0 if not available.
The error message that explains the reason for the exception.
The service specific error code.
The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.
Initializes a new instance of the class with serialized data.The that holds the serialized object data about the exception being thrown.The that contains contextual information about the source or destination. is .The class name is or is zero (0).
When overridden in a derived class, sets the with information about the exception.The that holds the serialized object data about the exception being thrown.The that contains contextual information about the source or destination.The parameter is a null reference ( in Visual Basic).
Represents the HTTP response from the service.
Gets the HTTP status code.
Gets the HTTP reason phrase.
Gets the contents of HTTP response. Returns null for responses without content.
Gets the client request id that was sent to the server as x-ms-client-request-id headers.
Get the HTTP response headers.
Frees resources held by this instance.
Returns header value if the header is stored in the collection. If header has multiple values they are going to be joined with a comma.
The header name.
The reference to populate with value.
true if the specified header is stored in the collection, otherwise false.
Returns header values if the header is stored in the collection.
The header name.
The reference to populate with values.
true if the specified header is stored in the collection, otherwise false.
Returns true if the header is stored in the collection.
The header name.
true if the specified header is stored in the collection, otherwise false.
Returns an iterator for enumerating in the response.
The enumerating in the response.
Creates a new instance of with the provided value and HTTP response.
The type of the value.
The value.
The HTTP response.
A new instance of with the provided value and HTTP response.
Returns the string representation of this .
The string representation of this
Represents a result of Azure operation.
The type of returned value.
Returns the HTTP response returned by the service.
The HTTP response returned by the service.
Gets the value returned by the service.
Returns the value of this object.
The instance.
Determines whether the specified object is equal to the current object.The object to compare with the current object. if the specified object is equal to the current object; otherwise, .
Serves as the default hash function.A hash code for the current object.
Returns a string that represents the current object.A string that represents the current object.
Specifies that null is allowed as an input even if the corresponding type disallows it.
Specifies that null is disallowed as an input even if the corresponding type allows it.
Specifies that an output may be null even if the corresponding type disallows it.
Specifies that an output will not be null even if the corresponding type allows it.
Specifies that when a method returns , the parameter may be null even if the corresponding type disallows it.
Initializes the attribute with the specified return value condition.
The return value condition. If the method returns this value, the associated parameter may be null.
Gets the return value condition.
Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it.
Initializes the attribute with the specified return value condition.
The return value condition. If the method returns this value, the associated parameter will not be null.
Gets the return value condition.
Specifies that the output will be non-null if the named parameter is non-null.
Initializes the attribute with the associated parameter name.
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
Gets the associated parameter name.
Applied to a method that will never return under any circumstance.
Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
Initializes the attribute with the specified parameter value.
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
the associated parameter matches this value.
Gets the condition parameter value.
Returns an enumerator that iterates through a collection.An object that can be used to iterate through the collection.
Returns an enumerator that iterates through the collection.An enumerator that can be used to iterate through the collection.
Returns an enumerator that iterates through a collection.An object that can be used to iterate through the collection.
Gets the element in the collection at the current position of the enumerator.The element in the collection at the current position of the enumerator.