BlobClientOptions Class

Definition

Namespace:

Azure.Storage.Blobs

Assembly:

Azure.Storage.Blobs.dll

Package:

Azure.Storage.Blobs v12.19.1

Source:

BlobClientOptions.cs

Provides the client configuration options for connecting to Azure Blob Storage.

public class BlobClientOptions : Azure.Core.ClientOptions

type BlobClientOptions = class
    inherit ClientOptions

Public Class BlobClientOptions
Inherits ClientOptions

Inheritance

Object

ClientOptions

BlobClientOptions

Derived

Azure.Storage.Blobs.Specialized.SpecializedBlobClientOptions

Constructors

BlobClientOptions(BlobClientOptions+ServiceVersion)

Initializes a new instance of the BlobClientOptions class.

Properties

Audience	Gets or sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.
CustomerProvidedKey	Gets the CustomerProvidedKey to be used when making requests.
Diagnostics	Gets the client diagnostic options. (Inherited from ClientOptions)
EnableTenantDiscovery	Enables tenant discovery through the authorization challenge when the client is configured to use a TokenCredential. When enabled, the client will attempt an initial un-authorized request to prompt a challenge in order to discover the correct tenant for the resource.
EncryptionScope	Gets the EncryptionScope to be used when making requests.
GeoRedundantSecondaryUri	Gets or sets the secondary storage Uri that can be read from for the storage account if the account is enabled for RA-GRS. If this property is set, the secondary Uri will be used for GET or HEAD requests during retries. If the status of the response from the secondary Uri is a 404, then subsequent retries for the request will not use the secondary Uri again, as this indicates that the resource may not have propagated there yet. Otherwise, subsequent retries will alternate back and forth between primary and secondary Uri.
Retry	Gets the client retry options. (Inherited from ClientOptions)
RetryPolicy	Gets or sets the policy to use for retries. If a policy is specified, it will be used in place of the Retry property. The RetryPolicy type can be derived from to modify the default behavior without needing to fully implement the retry logic. If Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) is overridden or a custom HttpPipelinePolicy is specified, it is the implementer's responsibility to update the ProcessingContext values. (Inherited from ClientOptions)
TransferValidation	Configures whether to send or receive checksum headers for blob uploads and downloads. Downloads can optionally validate that the content matches the checksum.
Transport	The HttpPipelineTransport to be used for this client. Defaults to an instance of HttpClientTransport. (Inherited from ClientOptions)
TrimBlobNameSlashes	Whether to trim leading and trailing slashes on a blob name when using GetBlobClient(String) and similar methods. Defaults to true for backwards compatibility.
Version	Gets the BlobClientOptions.ServiceVersion of the service API used when making requests. For more, see Versioning for Azure Storage Services.

Methods

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Adds an HttpPipeline policy into the client pipeline. The position of policy in the pipeline is controlled by the position parameter. If you want the policy to execute once per client request use PerCall otherwise use PerRetry to run the policy for every retry. Note that the same instance of policy would be added to all pipelines of client constructed using this ClientOptions object. (Inherited from ClientOptions)