System.ClientModel

A credential used to authenticate to a service that accepts an API key. This type provides the ability to update the key's value without creating a new client.

Initializes a new instance of the class.

The API key to used to authenticate with the service. Thrown when the is null. Thrown when the is empty.

Deconstructs the credential into component values.

When this method returns, contains the value of the API key this instance represents.

Updates the API key to used to authenticate with the service. This method is intended to be called when the API key has been regenerated and long-lived clients need to be updated to send the new value.

The new value for the API key to used to authenticate with the service. Thrown when the is null. Thrown when the is empty.

Represents a collection of values returned from a cloud service operation. The collection values may be delivered over one or more service responses.

Creates a new instance of .

Gets the collection of page responses that contain the items in this collection.

A collection of service responses where each holds a subset of items in the full collection. This method does not take a parameter. implementations must store the passed to the service method that creates them and pass that token to any async methods called from this method. For protocol methods, this will come from the property.

Gets a that can be passed to a client method to obtain a collection holding the items remaining in this .

The raw page to obtain a continuation token for. A that a client can use to obtain an whose items start at the first item after the last item in , or null if is the last page in the sequence of page responses delivering the items in the collection.

Represents a collection of values returned from a cloud service operation. The collection values may be delivered over one or more service responses.

Creates a new instance of .

Gets the collection of page responses that contain the items in this collection.

A collection of service responses where each holds a subset of items in the full collection. implementations are expected to store the passed to the service method that creates them and pass that token to any methods making service calls that are called from this method. For protocol methods, this will come from the property.

Gets a that can be passed to a client method to obtain a collection holding the remaining items in this .

Represents an operation that runs asynchronously on a cloud service. Cloud services use long-running operations to allow users to start an operation with one request and then monitor progress of the operation until it has completed. enables waiting for completion of long-running operations. Client libraries provide derived types that add properties such as Value or Status as applicable for a given service operation.

Creates a new instance of .

The received from the service in response to the request that started the operation.

Gets a value that indicates whether the operation has completed.

true if the operation has reached a terminal state (that is, it has finished successfully, ended due to an error condition, or has been cancelled by a user); otherwise, false. is updated by the method, based on the response received from the service regarding the operation's status. Users must call , , or other method provided by the derived type to ensure that the value of the property reflects the current status of the operation running on the service.

Gets a token that can be used to rehydrate the operation.

A token that can be used to rehydrate the operation, for example to monitor its progress or to obtain its final result, from a process different than the one that started the operation. This property is abstract so that derived types that do not support rehydration can return null without using a backing field for an unused .

Sends a request to the service to get the current status of the operation and updates and other relevant properties.

The to be used when sending the request to the service. The returned from the service call. This method updates the value returned from and will update to true once the operation has finished running on the service. It will also update Value or Status properties if present on the derived type.

Sends a request to the service to get the current status of the operation and updates and other relevant properties.

Waits for the operation to complete processing on the service.

Derived types may override to implement different mechanisms for obtaining updates from the service regarding the progress of the operation. For example, if the derived type polls for status updates, it may provides overloads of that allow the caller to specify the polling interval or delay strategy used to wait between sending request for updates. By default, waits a default interval between calling to obtain a status updates, so if updates are delivered via streaming or another mechanism where a wait time is not required, derived types can override this method to update the status more frequently. The was cancelled.

Waits for the operation to complete processing on the service.

Gets the corresponding to the most recent update received from the service.

The most recent received from the service.

Update the value returned from .

The to return from .

Represents an HTTP message that can be sent from a . holds the request sent to the cloud service, and holds the response received from the service.

Creates an instance of with set to the provided .

The to set on this instance's property.

Gets the to send to the service during the call to .

Gets the received from the service during the call to .

Returns the value of the property and transfers dispose ownership of the response to the caller. After calling this method, the property will be null and the caller will be responsible for disposing the returned value, which may hold a live network stream.

Gets or sets the used for the duration of the call to .

Gets or sets the used by the to determine whether the response received from the service is considered an error and populate the on . This property is intended to be set in a client's service method to a a that classifies responses as success responses based on the service API's published success codes. Setting this value outside the service method will override the client-specified classifier and may result in undesired behavior.

Apply the options from the provided to this instance.

The to apply to this instance. If null is passed, no changes will be made to this message instance. This method is intended to be called after the creation of the and its is complete, and prior to the call to .

Attempts to get a property from the property bag for this instance. Message properties are used to govern the behavior of specific policies in the . Please refer to documentation for a specific to understand what properties it supports.

The key for the property in the message's property bag. The value of the property. true if property exists; otherwise false.

Set a property in the property bag for this instance. Message properties are used to govern the behavior of specific policies in the . Please refer to documentation for a specific to understand what properties it supports.

The key for the property in the message's property bag. The value of the property.

Gets or sets the value indicating whether the response should be buffered in-memory by the pipeline. Defaults to true.

Gets or sets the network timeout value for this message. If null, the value set on the client's options will be used. Defaults to null.

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Releases the unmanaged resources used by the and optionally disposes of the managed resources.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Represents an HTTP request to be sent to a cloud service. The type of a is specific to the type of the used by the that sends the request. Because of this, is used to create an instance of for a given pipeline.

Gets or sets the HTTP method used by the HTTP request.

Gets or sets the derived-type's value of the request's .

Gets or sets the used for the HTTP request.

Gets or sets the derived-type's value of the request's .

Gets the collection of HTTP request headers.

Gets or sets the derived-type's value of the request's collection.

Gets or sets the contents of the HTTP request.

Gets or sets the derived-type's value of the request's .

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Represents the collection of HTTP headers on a .

Adds the specified header and its value to the request's header collection. If a header with this name is already present in the collection, the value will be added to the comma-separated list of values associated with the header.

The name of the header to add. The value of the header.

Sets the specified header and its value in the request's header collection. If a header with this name is already present in the collection, the header's value will be replaced with the specified value.

The name of the header to set. The value of the header.

Removes the specified header from the request's header collection.

The name of the header to remove. true if the header was successfully removed; otherwise false.

Attempts to retrieve the value associated with the specified header name.

The name of the header to retrieve. The specified header value. true if the specified header name and value are stored in the collection; otherwise false.

Attempts to retrieve the values associated with the specified header name.

The name of the header to retrieve. The specified header values. true if the specified header name and values are stored in the collection; otherwise false.

Returns an enumerator that iterates through the collection.

An enumerator that can be used to iterate through the collection.

Represents an HTTP response received from a cloud service.

Gets the status code of the HTTP response.

Gets the reason phrase that accompanies the status code on the HTTP response.

Gets the collection of HTTP response headers.

Gets or sets the derived-type's value of the response's collection.

Gets or sets the contents of the HTTP response.

may be a stream that contains the buffered contents transferred from the network stream that originally held the contents of the service response; or it may be the live network stream itself, depending on the value of on the message sent via . Please refer to the documentation for a client's service method if needed to understand whether this instance must be disposed to close the network stream.

Gets the contents of the HTTP response.

Thrown if the response is not buffered. holds the in-memory contents of the HTTP response when is true on the message sent via . If this instance was obtained from the return value of a client's service method, please refer to the documentation for the service method to understand whether this property can be accessed without throwing an exception. If this instance is accessed from a , please check the value of to determine whether to obtain the response content from or .

Transfer the contents of the response network stream from to a buffered cache on this instance.

The to use while buffering the content. The buffered content. This method will read the full content from the response content network stream into memory. Please be sure the contents will fit into memory before calling this method.

Transfer the contents of the response network stream from to a buffered cache on this instance.

Indicates whether the status code of the returned response is considered an error code.

Gets or sets the derived-type's value of .

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

A collection of HTTP response headers and their values.

Attempts to retrieve the value associated with the specified header name.

The name of the header to retrieve. The specified header value. true if the specified header name and value are stored in the collection; otherwise false.

Attempts to retrieve the values associated with the specified header name.

The name of the header to retrieve. The specified header values. true if the specified header name and values are stored in the collection; otherwise false.

Gets an enumerator that iterates through the .

An enumerator that iterates through the .

Allows an object to control its own JSON writing and reading.

The type the model can be converted into.

Writes the model to the provided .

The to write into. The to use. If the model does not support the requested .

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

The to read. The to use. A representation of the JSON value. If the model does not support the requested .

Allows an object to control its own writing and reading. The format is determined by the implementer.

The type the model can be converted into.

Writes the model into a .

The to use. A binary representation of the written model. If the model does not support the requested .

Converts the provided into a model.

The to parse. The to use. A representation of the data. If the model does not support the requested .

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

The to consider when serializing and deserializing the model. The format that the model uses when communicating with the serivce.

A generic converter which allows to be able to write and read any models that implement .

Since defines what the serialized shape should look like the are ignored except for those pertaining to indentation formatting.

Initializes a new instance of with a default options of .

Initializes a new instance of .

The to use.

Determines whether the type can be converted.

The default implementation is to return True when equals typeof(T). True if the type can be converted, False otherwise.

Read and convert the JSON to T.

A converter may throw any Exception, but should throw JsonException when the JSON is invalid. The to read from.The being converted.The being used.The value that was converted.Note that the value of determines if the converter handles null JSON tokens.

Write the value as JSON.

A converter may throw any Exception, but should throw JsonException when the JSON cannot be created. The to write to.The value to convert. Note that the value of determines if the converter handles values.The being used.

Provides functionality to read and write and .

Converts the value of a model into a .

The type of the value to write. The model to convert. The to use. A representation of the model in the specified by the . If the model does not support the requested . If is null.

Converts the value of a model into a .

The model to convert. The to use. A representation of the model in the specified by the . Throws if does not implement . If the model does not support the requested . If is null.

Converts the into a .

The to convert. The to use. A representation of the . Throws if does not have a public or internal parameterless constructor. If the model does not support the requested . If is null. If does not have a public or non public empty constructor.

Converts the into a .

The to convert. The type of the objec to convert and return. The to use. A representation of the . Throws if does not implement . Throws if does not have a public or internal parameterless constructor. If the model does not support the requested . If or are null. If does not have a public or non public empty constructor.

Provides the client options for reading and writing models.

Default options for writing models into JSON format.

Default options for writing models into XML format.

Initializes a new instance of .

The format to read and write models.

Gets the format to read and write the model.

Attribute that indicates a proxy to use for reading a model. The proxy must implement and have a public or non-public parameterless constructor.

Instantiates a new instance of the class.

The to create and call read on. The must have a public or non-public parameterless constructor. The must implement where T is the type of the abstract class.

Gets the to create and call read on. The must have a public or non-public parameterless constructor. The must implement where T is the type of the abstract class.

ClientErrorBehaviors controls the behavior of a service method when an unexpected response status code is received.

The client will throw an exception from a service method if the service returns an error response.

The client will not throw an exception from a service method if the service returns an error response. Callers of the service method must check the Response.IsError property before accessing the response content.

Options that control the creation of a used by a service client to send and receive HTTP messages. Service clients must create a client-specific subtype of this class to pass to their constructors to allow for service-specific options with a client-wide scope.

Gets or sets the to be used by the for handling retry logic.

In most cases, this property will be set to an instance of .

Gets or sets the to be used by the for sending and receiving HTTP messages.

In most cases, this property will be set to an instance of .

The timeout applied to an individual network operation.

Adds the provided to the default .

The to add to the pipeline. The position of the policy in the pipeline. Thrown when the provided policy is null. For a policy to run once per invocation of , use , which will insert the policy before the pipeline's . For a policy to run once per retry attempt, use , which will insert the policy after the pipeline's . To ensure that a policy runs after all other policies in the pipeline have viewed the and before all other policies view the , use . Changes made to by a before-transport policy will not be visible to any logging policies that come before it in the pipeline.

Freeze this instance of . After this method has been called, any attempt to set properties on the instance or call methods that would change its state will throw .

Assert that has not been called on this instance.

Thrown when an attempt is made to change the state of this instance after has been called.

A classifier that can evaluate a in two ways. First, given an HTTP message, the can determine whether the service response it holds should be considered an error response. Second, given an HTTP message and an optional pipeline exception, the classifier can determine whether or not the should retry the request.

A default classifier instance. This classifier will classify a with a status code of 4xx or 5xx as an error, and with a status code of 408, 429, 500, 502, 503 and 504 as retriable.

Create an instance of a from a collection of success status codes.

The status codes that the returned classifier instance will classifiy as success codes. A instance that classifies the status codes provided by as success codes.

Attempt to evaluate whether the provided contains a that the client should consider an error response.

The to classify. true if the should be considered an error response. true if the classifier had an opinion regarding whether the service response was an error response; false otherwise. Not all classifiers derived from will classify a given . Returning false from allows a classifier instance to compose with other classifiers by passing the classification decision to a later instance. will always return true from and may be used as the last classifier in any composed classifier collection.

Attempt to evaluate whether the provided contains a that indicates the client should retry the .

The to classify. An , if any, that will also be used in the retry classification. Callers are intended to provide any exception thrown during the attempt to send the prior request. true if the should be retried. true if the classifier had an opinion regarding whether the service request should be retried; false otherwise. Not all classifiers derived from will classify a given . Returning false from allows a classifier instance to compose with other classifiers by passing the classification decision to a later instance. will always return true from and may be used as the last classifier in any composed classifier collection.

Options that can be used to control the behavior of a request sent by a client.

Initializes a new instance of the class

Gets or sets the used for the duration of the call to .

Gets or sets a value that describes when a client's service method will raise an exception if the underlying response is considered an error.

Gets or sets a value indicating whether the response content should be buffered in-memory by the pipeline. This value defaults to true.

Please note that setting this value to false will result in the obtained from holding a live network stream. It is the responsibility of the caller to ensure the stream is disposed.

The name of the header to add. The value of the header.

The name of the header to set. The value of the header.

Adds a into the pipeline for the duration of this request.

The to add to the pipeline. The position of the policy in the pipeline. Thrown when the provided policy is null.

Apply the options provided in this instance to the .

The to apply the options to.

Freeze this instance of . After this method has been called, any attempt to set properties on the instance or call methods that would change its state will throw .

Assert that has not been called on this instance.

Thrown when an attempt is made to change the state of this instance after has been called.

Creates a new instance of .

The status codes that this classifier will consider not to be errors.

A that uses an to set a value on a to authenticate with the cloud service.

Create a new instance of the class, where the credential value will be specified in a request header.

The used to authenticate requests. The name of the request header used to send the key credential in the request. A prefix to prepend before the key credential in the header value. If provided, the prefix string will be followed by a space and then the credential string. For example, setting valuePrefix to "SharedAccessKey" will result in the header value being set to "SharedAccessKey {credential.Key}".

Create a new instance of the class, where the credential value will be set in the Authorization header on the with a Basic prefix.

The used to authenticate requests.

Create a new instance of the class, where the credential value will be set in the Authorization header on the with a Bearer prefix.

The used to authenticate requests.

Process the provided according to the intended purpose of this instance. Derived types must pass control to the next in the pipeline by calling .

The to process. The collection of instances in the instance whose method was called to invoke this method. The index of this policy in the policy list. This value should be passed to to pass control to the next policy in the pipeline.

Process the provided according to the intended purpose of this instance. Derived types must pass control to the next in the pipeline by calling .

Represents an extensible pipeline used by clients that call cloud services to send and receive HTTP request and responses. Creators of can modify how it process a by adding instances at various points in the default pipeline.

Create an instance of a from the provided .

If provided, the to use to construct the . The created instance.

Create an instance of a from the provided and collections.

The to use to construct the . A collection of instances to add to the default pipeline before the pipeline's retry policy. A collection of instances to add to the default pipeline after the pipeline's retry policy. A collection of instances to add to the default pipeline before the pipeline's transport. The created instance. Policies provided in are intended to come from the end-user of a client who has passed the instance to the client's constructor. The client constructor implementation is intended to pass client-specific policies using the , , and parameters and should not modify the provided by the client user.

Creates a that can be sent using this pipeline instance.

The created .

Send the provided .

The to send. Thrown if an error other than the service responding with an error response occurred while sending the HTTP request. All necessary values on should be set prior to calling . After the method returns, will be populated with the details of the service response.

Send the provided .

Pipeline processor to advance through policies for pipeline customized per-request by passing RequestOptions to a protocol method.

A used by a to decide whether or not to retry a .

The instance used by a default .

Creates a new instance of the class.

The maximum number of retries to attempt.

Process the provided according to the intended purpose of this instance. Derived types must pass control to the next in the pipeline by calling .

A method that can be overridden by derived types to extend the default logic. It is called from prior to passing control to the next policy in the pipeline.

The containing the to be sent to the service.

A method that can be overridden by derived types to extend the default logic. It is called from prior to passing control to the next policy in the pipeline.

The containing the to be sent to the service.

A method that can be overridden by derived types to extend the default logic. It is called from just after control has been returned from the policy at the position after the retry policy in the pipeline.

The containing the that was received from the service.

A method that can be overridden by derived types to extend the default logic. It is called from after the time interval for the current retry attempt has passed.

The for this pipeline invocation.

A method that can be overridden by derived types to customize the default logic. It is called from after control has been returned from the policy at the position after the retry policy in the pipeline.

The for this pipeline invocation. The exception, if any, that was thrown from a policy after the retry policy in the pipeline.

A method that can be overridden by derived types to customize the default logic. It is called from to determine how long the policy should wait before re-sending the request.

The for this pipeline invocation. A number indicating how many times the policy has tried to send the request. The amount of time to wait before the next retry attempt.

A method that can be overridden by derived types to customize the default logic. It is called from to wait the time interval returned by .

The amount of time to wait before trying to send the request again. The used to cancel the wait if needed. A task that can be awaited to asynchronously delay before the next retry attempt.

A method that can be overridden by derived types to customize the default logic. It is called from to wait the time interval returned by .

The amount of time to wait before trying to send the request again. The used to cancel the wait if needed.

An implementation of that uses a to send and receive HTTP requests and responses.

A default instance of that can be shared across pipelines and clients.

Create a new instance of that uses a shared default instance of .

Create a new instance of that uses the provided .

The that this transport instance will use to send and receive HTTP requests and responses.

Creates a new transport-specific instance of . Types that derive from must implement this method to provide transport-specific functionality.

A that can be passed to .

Transport-specific implementation used to sends the HTTP request contained by and set the value of . Types that derive from must implement this method to provide transport-specific functionality.

The containing the request that was sent and response that was received by the transport.

Transport-specific implementation used to sends the HTTP request contained by and set the value of . Types that derive from must implement this method to provide transport-specific functionality.

The containing the request that was sent and response that was received by the transport.

A method that can be overridden by derived types to extend the default logic. It is called from prior to sending the HTTP request.

The containing the resulting from the processing of the policies in the containing this transport. The created by the transport that will be sent to the service using this transport's instance.

A method that can be overridden by derived types to extend the default logic. It is called from after the transport has created the and set it on .

The containing the created by the transport. The returned by from the call to Send on that the transport used to create .

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Releases the unmanaged resources used by the and optionally disposes of the managed resources.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

A policy that can be added to a to process a during a call to . Types deriving from can read or modify the , implement functionality based on , and must pass control to the next in the pipeline by calling .

Process the provided according to the intended purpose of this instance. Derived types must pass control to the next in the pipeline by calling .

Passes control to the next in the .

The to process. The collection of instances in the . The index of this policy in the policy list. The derived-type implementation of should pass the value of it received without modifying it.

Passes control to the next in the .

The to process. The collection of instances in the . The index of this policy in the policy list. The derived-type implementation of should pass the value of it received without modifying it.

The position at which to insert a into the default policy collection.

Insert the before the pipeline's . Policies added to a pipeline in this position will run once per invocation of .

Insert the after the pipeline's . Policies added to a pipeline in this position will run each time the pipeline tries to send the .

Insert the just before the pipeline's . Policies added to a pipeline in this position will run after all other polices in the have viewed the and before they view the . Adding policies at this position should be done with care since changes made to the by a before-transport policy will not be visible to any logging policies that come before it in the pipeline.

Represents an HTTP pipeline transport used to send and receive HTTP requests and responses.

Create an instance of that can be sent using this transport instance. This method will rarely be called directly; should be called instead.

A that can be passed to .

Creates a new transport-specific instance of . Types that derive from must implement this method to provide transport-specific functionality.

A that can be passed to .

Sends the HTTP request contained by and sets the value of .

The containing the request that was sent and response that was received by the transport.

Sends the HTTP request contained by and sets the value of .

The containing the request that was sent and response that was received by the transport.

Transport-specific implementation used to sends the HTTP request contained by and set the value of . Types that derive from must implement this method to provide transport-specific functionality.

The containing the request that was sent and response that was received by the transport.

Transport-specific implementation used to sends the HTTP request contained by and set the value of . Types that derive from must implement this method to provide transport-specific functionality.

The containing the request that was sent and response that was received by the transport.

Implementation of . Since the transport is the last policy in the policy chain, this method does not call as other policy implementations do.

The to pass to . The collection of policies in the pipeline. The index of the current policy being processed in the pipeline invocation.

Implementation of . Since the transport is the last policy in the policy chain, this method does not call as other policy implementations do.

The to pass to . The collection of policies in the pipeline. The index of the current policy being processed in the pipeline invocation.

Represents a collection of values returned from a cloud service operation. The collection values may be delivered over one or more service responses.

Creates a new instance of .

Returns an enumerator that iterates asynchronously through the collection.

A that may be used to cancel the asynchronous iteration.An enumerator that can be used to iterate asynchronously through the collection.

Gets a collection of the values returned in a page response.

The service response to obtain the values from. A collection of values read from the response content in . This method does not take a parameter. implementations must store the passed to the service method that creates them and pass that token to any async methods called from this method.

Represents the result of a cloud service operation.

Creates a new instance of from a service response.

The received from the service.

Gets the received from the service.

The received from the service.

Creates a new instance of that holds the received from the service.

The response received from the service. A new instance of holding the provided .

Creates a new instance of that holds the provided model value and received from the service.

The type of the value. The strongly-typed representation of the service response payload value. The response received from the service. A new instance of holding the provided and .

Creates a new instance of that holds the provided model value, if any, and the received from the service. This method is used to create a return value for a service method representing a service operation that may or may not contain a payload. Callers of the client's service method must check whether is null to determine whether the service provided a value in its response. Nullable annotations indicate to the end-user the need to check whether is null.

The type of the value. The strongly-typed representation of the service response payload value. The response received from the service. A new instance of holding the provided and .

The exception that is thrown when the processing of a client request failed.

Asynchronously create an instance of from the containing the details of the service's error response.

The service's error response. The , if any, that threw the current exception. The instance that was created.

Gets the HTTP status code of the response. Returns. 0 if response was not received.

Initializes a new instance of from a containing the details of the service's error response. The is created from the provided .

The service's error response. The , if any, that threw the current exception.

Initializes a new instance of with a custom exception message and an optional . The is set to and if is provided, it will be returned from calls to this exception instance's method.

The message to set on . The response, if any, to return from . The , if any, that threw the current exception.

Gets the , if any, that led to the exception.

The , if any, that led to the exception.

Represents the result of a cloud service operation, and provides a strongly-typed representation of the service response value.

The type of the value returned in the service response.

Creates a new instance of that holds the provided model value and received from the service.

The strongly-typed representation of the service response payload value. The response received from the service.

Gets the value received from the service.

Returns the value of this object.

The instance.

Represents a collection of values returned from a cloud service operation. The collection values may be delivered over one or more service responses.

Creates a new instance of .

Returns an enumerator that iterates through the collection.

An enumerator that can be used to iterate through the collection.

Gets a collection of the values returned in a page response.

The service response to obtain the values from. A collection of values read from the response content in . implementations are expected to store the passed to the service method that creates them and pass that token to any methods making service calls that are called from this method.

A token that can be passed to a client method to request or rehydrate a subclient from the state represented by the token.

Create a new instance of .

This constructor is used by derived types to create an instance from values held by the client.

Create a new instance of .

Bytes that can be deserialized into a subtype of .

Create a new instance of from the provided .

Bytes obtained from calling on a . A that can be passed to a client method to request or rehydrate a subclient equivalent to the one from which the original bytes were obtained.

Write the bytes of this .

The bytes of this . Thrown if not implemented in a derived 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.

A property bag which is optimized for storage of a small number of items. If the item count is less than 2, there are no allocations. Any additional items are stored in an array which will grow as needed. MUST be passed by ref only.

This type effectively stores 640 bool values, but compresses their storage into ten ulongs, where each bit of the ulong represents a single bool value. It exposes a public indexer so that the bool values can be accessed as a standard .NET collection API. It is used in System.ClientModel and Azure.Core to implement response classifiers, where each true bit represents a status code that the classifier considers a success code.

Determines whether to wrap an in a cancellation exception.

The exception. The that may have triggered the exception. true if the exception should be wrapped; otherwise, false.

Creates a cancellation exception.

The inner exception to wrap. May be null. The that triggered the cancellation. The custom message to use. The cancellation exception.

Throws a cancellation exception if cancellation has been requested via .

The token to check for a cancellation request. The inner exception to wrap. May be null.

Throws a cancellation exception if cancellation has been requested via or .

The user-provided token. The linked token that is cancelled on timeout provided token. The inner exception to use. The timeout used for the operation.

Read-only Stream that will throw a if it has to wait longer than a configurable timeout to read more data

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.

Provides an efficient way to write into a using multiple pooled buffers.

Initializes a new instance of .

The model to write. The to use. If the model does not support the requested .

This class is a helper to write to a in a thread safe manner. It uses the shared pool to allocate buffers and returns them to the pool when disposed. Since there is no way to ensure someone didn't keep a reference to one of the buffers it must be disposed of in the same context it was created and its referenced should not be stored or shared.

Provides a way to read a without exposing the underlying buffers. This class is not thread safe and should only be used by one thread at a time. If you dispose while another thread is copying you will end up with a partial copy.

Initializes a new instance of .

The size of each buffer segment.

Notifies the that bytes bytes were written to the output or . You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer.

The number of bytes written to the or .

Returns a to write to that is at least the requested size, as specified by the parameter.

The minimum length of the returned . If less than 256, a buffer of size 256 will be returned. A memory buffer of at least bytes. If is less than 256, a buffer of size 256 will be returned.

Returns a to write to that is at least the requested size, as specified by the parameter.

The minimum length of the returned . If less than 256, a buffer of size 256 will be returned. A buffer of at least bytes. If is less than 256, a buffer of size 256 will be returned.

Disposes the SequenceWriter and returns the underlying buffers to the pool.

Represents binary content that can be sent to a cloud service as part of a .

Creates an instance of that contains the bytes held in the provided instance.

The containing the bytes this will hold. An an instance of that contains the bytes held in the provided instance.

Creates an instance of that contains the bytes resulting from writing the value of the provided .

The to write. The , if any, that indicates what format the will be written in. An instance of that wraps a .

Creates an instance of that contains the bytes held in the provided instance.

The containing the bytes this will hold. An an instance of that contains the bytes held in the provided instance.

Attempts to compute the length of the underlying body content, if available.

The length of the underlying data.

Writes contents of this instance to the provided .

The stream to write the binary content to. To to use for the write operation.

Writes contents of this instance to the provided .

The stream to write the binary content to. To to use for the write operation.

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

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.

Indicates that the specified method requires the ability to generate new code at runtime, for example through .

This allows tools to understand which methods are unsafe to call when compiling ahead of time.

Initializes a new instance of the class with the specified message.

A message that contains information about the usage of dynamic code.

Gets a message that contains information about the usage of dynamic code.

Gets or sets an optional URL that contains more information about the method, why it requires dynamic code, and what options a consumer has to deal with it.

Indicates that the specified method requires dynamic access to code that is not referenced statically, for example through .

This allows tools to understand which methods are unsafe to call when removing unreferenced code from an application.

Initializes a new instance of the class with the specified message.

A message that contains information about the usage of unreferenced code.

Gets a message that contains information about the usage of unreferenced code.

Gets or sets an optional URL that contains more information about the method, why it requires unreferenced code, and what options a consumer has to deal with it.

Suppresses reporting of a specific rule violation, allowing multiple suppressions on a single code artifact.

is different than in that it doesn't have a . So it is always preserved in the compiled assembly.

Initializes a new instance of the class, specifying the category of the tool and the identifier for an analysis rule.

The category for the attribute. The identifier of the analysis rule the attribute applies to.

Gets the category identifying the classification of the attribute.

The property describes the tool or tool analysis category for which a message suppression attribute applies.

Gets the identifier of the analysis tool rule to be suppressed.

Concatenated together, the and properties form a unique check identifier.

Gets or sets the scope of the code that is relevant for the attribute.

The Scope property is an optional argument that specifies the metadata scope for which the attribute is relevant.

Gets or sets a fully qualified path that represents the target of the attribute.

The property is an optional argument identifying the analysis target of the attribute. An example value is "System.IO.Stream.ctor():System.Void". Because it is fully qualified, it can be long, particularly for targets such as parameters. The analysis tool user interface should be capable of automatically formatting the parameter.

Gets or sets an optional argument expanding on exclusion criteria.

The property is an optional argument that specifies additional exclusion where the literal metadata target is not sufficiently precise. For example, the cannot be applied within a method, and it may be desirable to suppress a violation against a statement in the method that will give a rule violation, but not against all statements in the method.

Gets or sets the justification for suppressing the code analysis message.

States a dependency that one member has on another.

This can be used to inform tooling of a dependency that is otherwise not evident purely from metadata and IL, for example a member relied on via reflection.

Initializes a new instance of the class with the specified signature of a member on the same type as the consumer.

The signature of the member depended on.

Initializes a new instance of the class with the specified signature of a member on a .

The signature of the member depended on. The containing .

Initializes a new instance of the class with the specified signature of a member on a type in an assembly.

The signature of the member depended on. The full name of the type containing the specified member. The assembly name of the type containing the specified member.

Initializes a new instance of the class with the specified types of members on a .

The types of members depended on. The containing the specified members.

Initializes a new instance of the class with the specified types of members on a type in an assembly.

The types of members depended on. The full name of the type containing the specified members. The assembly name of the type containing the specified members.

Gets the signature of the member depended on.

Either must be a valid string or must not equal , but not both.

Gets the which specifies the type of members depended on.

Either must be a valid string or must not equal , but not both.

Gets the containing the specified member.

If neither nor are specified, the type of the consumer is assumed.

Gets the full name of the type containing the specified member.

If neither nor are specified, the type of the consumer is assumed.

Gets the assembly name of the specified type.

is only valid when is specified.

Gets or sets the condition in which the dependency is applicable, e.g. "DEBUG".

Indicates that certain members on a specified are accessed dynamically, for example through .

This allows tools to understand which members are being accessed during the execution of a program. This attribute is valid on members whose type is or . When this attribute is applied to a location of type , the assumption is that the string represents a fully qualified type name. When this attribute is applied to a class, interface, or struct, the members specified can be accessed dynamically on instances returned from calling on instances of that class, interface, or struct. If the attribute is applied to a method it's treated as a special case and it implies the attribute should be applied to the "this" parameter of the method. As such the attribute should only be used on instance methods of types assignable to System.Type (or string, but no methods will use it there).

Initializes a new instance of the class with the specified member types.

The types of members dynamically accessed.

Gets the which specifies the type of members dynamically accessed.

Specifies the types of members that are dynamically accessed. This enumeration has a attribute that allows a bitwise combination of its member values.

Specifies no members.

Specifies the default, parameterless public constructor.

Specifies all public constructors.

Specifies all non-public constructors.

Specifies all public methods.

Specifies all non-public methods.

Specifies all public fields.

Specifies all non-public fields.

Specifies all public nested types.

Specifies all non-public nested types.

Specifies all public properties.

Specifies all non-public properties.

Specifies all public events.

Specifies all non-public events.

Specifies all interfaces implemented by the type.

Specifies all members.

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 a collection.

An object 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.

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.

Returns an enumerator that iterates through a collection.

An object that can be used to iterate through the collection.