Class BlobContainerClient | Azure SDK for .NET

Inheritance

System.Object

BlobContainerClient

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Storage.Blobs.dll

Syntax

public class BlobContainerClient

Constructors

BlobContainerClient()

Declaration

protected BlobContainerClient ();

BlobContainerClient(String, String)

Declaration

public BlobContainerClient (string connectionString, string blobContainerName);

Parameters

System.String connectionString

A connection string includes the authentication information required for your application to access data in an Azure Storage account at runtime.

For more information,Configure Azure Storage connection strings

System.String blobContainerName

The name of the blob container in the storage account to reference.

BlobContainerClient(Uri, BlobClientOptions)

Declaration

public BlobContainerClient (Uri blobContainerUri, Azure.Storage.Blobs.BlobClientOptions options = null);

Parameters

System.Uri blobContainerUri

A Uri referencing the blob container that includes the name of the account and the name of the container. This is likely to be similar to "".

BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

BlobContainerClient(String, String, BlobClientOptions)

Declaration

public BlobContainerClient (string connectionString, string blobContainerName, Azure.Storage.Blobs.BlobClientOptions options);

Parameters

System.String connectionString

A connection string includes the authentication information required for your application to access data in an Azure Storage account at runtime.

For more information,Configure Azure Storage connection strings

System.String blobContainerName

The name of the container in the storage account to reference.

BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

BlobContainerClient(Uri, AzureSasCredential, BlobClientOptions)

Declaration

public BlobContainerClient (Uri blobContainerUri, Azure.AzureSasCredential credential, Azure.Storage.Blobs.BlobClientOptions options = null);

Parameters

System.Uri blobContainerUri

A Uri referencing the blob container that includes the name of the account and the name of the container. This is likely to be similar to "". Must not contain shared access signature, which should be passed in the second parameter.

Azure.AzureSasCredential credential

The shared access signature credential used to sign requests.

BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

BlobContainerClient(Uri, TokenCredential, BlobClientOptions)

Declaration

public BlobContainerClient (Uri blobContainerUri, Azure.Core.TokenCredential credential, Azure.Storage.Blobs.BlobClientOptions options = null);

Parameters

System.Uri blobContainerUri

A Uri referencing the blob container that includes the name of the account and the name of the container. This is likely to be similar to "".

Azure.Core.TokenCredential credential

The token credential used to sign requests.

BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

BlobContainerClient(Uri, StorageSharedKeyCredential, BlobClientOptions)

Declaration

public BlobContainerClient (Uri blobContainerUri, Azure.Storage.StorageSharedKeyCredential credential, Azure.Storage.Blobs.BlobClientOptions options = null);

Parameters

System.Uri blobContainerUri

A Uri referencing the blob container that includes the name of the account and the name of the container. This is likely to be similar to "".

Azure.Storage.StorageSharedKeyCredential credential

The shared key credential used to sign requests.

BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Fields

LogsBlobContainerName

The Azure Storage name used to identify a storage account's logs container.

Declaration

public static readonly string LogsBlobContainerName;

Field Value

System.String

RootBlobContainerName

The Azure Storage name used to identify a storage account's root container.

Declaration

public static readonly string RootBlobContainerName;

Field Value

System.String

WebBlobContainerName

The Azure Storage name used to identify a storage account's web content container.

Declaration

public static readonly string WebBlobContainerName;

Field Value

System.String

Properties

AccountName

Gets the Storage account name corresponding to the container client.

Declaration

public virtual string AccountName { get; }

Property Value

System.String

CanGenerateSasUri

Determines whether the client is able to generate a SAS. If the client is authenticated with a Azure.Storage.StorageSharedKeyCredential.

Declaration

public virtual bool CanGenerateSasUri { get; }

Property Value

System.Boolean

Name

Gets the name of the container.

Declaration

public virtual string Name { get; }

Property Value

System.String

Uri

Gets the container's primary Uri endpoint.

Declaration

public virtual Uri Uri { get; }

Property Value

System.Uri

Methods

Create(PublicAccessType, IDictionary<String,String>, CancellationToken)

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo> Create (Azure.Storage.Blobs.Models.PublicAccessType publicAccessType, System.Collections.Generic.IDictionary<string,string> metadata, System.Threading.CancellationToken cancellationToken);

Parameters

PublicAccessType publicAccessType

Optionally specifies whether data in the container may be accessed publicly and the level of access. BlobContainerspecifies full public read access for container and blob data. Clients can enumerate blobs within the container via anonymous request, but cannot enumerate containers within the storage account. Blob specifies public read access for blobs. Blob data within this container can be read via anonymous request, but container data is not available. Clients cannot enumerate blobs within the container via anonymous request. None specifies that the container data is private to the account owner.

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this container.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobContainerInfo>

A Azure.Response describing the newly created blob container.

Create(PublicAccessType, IDictionary<String,String>, BlobContainerEncryptionScopeOptions, CancellationToken)

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo> Create (Azure.Storage.Blobs.Models.PublicAccessType publicAccessType = Azure.Storage.Blobs.Models.PublicAccessType.None, System.Collections.Generic.IDictionary<string,string> metadata = null, Azure.Storage.Blobs.Models.BlobContainerEncryptionScopeOptions encryptionScopeOptions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

PublicAccessType publicAccessType

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this container.

BlobContainerEncryptionScopeOptions encryptionScopeOptions

Optional encryption scope options to set for this container.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobContainerInfo>

A Azure.Response describing the newly created blob container.

CreateAsync(PublicAccessType, IDictionary<String,String>, CancellationToken)

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo>> CreateAsync (Azure.Storage.Blobs.Models.PublicAccessType publicAccessType, System.Collections.Generic.IDictionary<string,string> metadata, System.Threading.CancellationToken cancellationToken);

Parameters

PublicAccessType publicAccessType

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this container.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobContainerInfo>>

A Azure.Response describing the newly created container.

CreateAsync(PublicAccessType, IDictionary<String,String>, BlobContainerEncryptionScopeOptions, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo>> CreateAsync (Azure.Storage.Blobs.Models.PublicAccessType publicAccessType = Azure.Storage.Blobs.Models.PublicAccessType.None, System.Collections.Generic.IDictionary<string,string> metadata = null, Azure.Storage.Blobs.Models.BlobContainerEncryptionScopeOptions encryptionScopeOptions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

PublicAccessType publicAccessType

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this container.

BlobContainerEncryptionScopeOptions encryptionScopeOptions

Optional encryption scope options to set for this container.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobContainerInfo>>

A Azure.Response describing the newly created container.

CreateClient(Uri, BlobClientOptions, HttpPipeline)

Declaration

protected static Azure.Storage.Blobs.BlobContainerClient CreateClient (Uri containerUri, Azure.Storage.Blobs.BlobClientOptions options, Azure.Core.Pipeline.HttpPipeline pipeline);

Parameters

System.Uri containerUri

A Uri referencing the block blob that includes the name of the account, the name of the container, and the name of the blob.

BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Azure.Core.Pipeline.HttpPipeline pipeline

The transport pipeline used to send every request.

Returns

CreateIfNotExists(PublicAccessType, IDictionary<String,String>, BlobContainerEncryptionScopeOptions, CancellationToken)

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo> CreateIfNotExists (Azure.Storage.Blobs.Models.PublicAccessType publicAccessType = Azure.Storage.Blobs.Models.PublicAccessType.None, System.Collections.Generic.IDictionary<string,string> metadata = null, Azure.Storage.Blobs.Models.BlobContainerEncryptionScopeOptions encryptionScopeOptions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

PublicAccessType publicAccessType

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this container.

BlobContainerEncryptionScopeOptions encryptionScopeOptions

Optional encryption scope options to set for this container.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobContainerInfo>

If the container does not already exist, a Azure.Responsedescribing the newly created container. If the container already exists, null.

CreateIfNotExists(PublicAccessType, IDictionary<String,String>, CancellationToken)

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo> CreateIfNotExists (Azure.Storage.Blobs.Models.PublicAccessType publicAccessType, System.Collections.Generic.IDictionary<string,string> metadata, System.Threading.CancellationToken cancellationToken);

Parameters

PublicAccessType publicAccessType

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this container.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobContainerInfo>

If the container does not already exist, a Azure.Responsedescribing the newly created container. If the container already exists, null.

CreateIfNotExistsAsync(PublicAccessType, IDictionary<String,String>, CancellationToken)

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo>> CreateIfNotExistsAsync (Azure.Storage.Blobs.Models.PublicAccessType publicAccessType, System.Collections.Generic.IDictionary<string,string> metadata, System.Threading.CancellationToken cancellationToken);

Parameters

PublicAccessType publicAccessType

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this container.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobContainerInfo>>

A Azure.Response describing the newly created container.

CreateIfNotExistsAsync(PublicAccessType, IDictionary<String,String>, BlobContainerEncryptionScopeOptions, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo>> CreateIfNotExistsAsync (Azure.Storage.Blobs.Models.PublicAccessType publicAccessType = Azure.Storage.Blobs.Models.PublicAccessType.None, System.Collections.Generic.IDictionary<string,string> metadata = null, Azure.Storage.Blobs.Models.BlobContainerEncryptionScopeOptions encryptionScopeOptions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

PublicAccessType publicAccessType

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this container.

BlobContainerEncryptionScopeOptions encryptionScopeOptions

Optional encryption scope options to set for this container.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobContainerInfo>>

A Azure.Response describing the newly created container.

Delete(BlobRequestConditions, CancellationToken)

Declaration

public virtual Azure.Response Delete (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on the deletion of this container.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response on successfully marking for deletion.

DeleteAsync(BlobRequestConditions, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteAsync (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on the deletion of this container.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response on successfully marking for deletion.

DeleteBlob(String, DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

Declaration

public virtual Azure.Response DeleteBlob (string blobName, Azure.Storage.Blobs.Models.DeleteSnapshotsOption snapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String blobName

The name of the blob to delete.

DeleteSnapshotsOption snapshotsOption

Specifies options for deleting blob snapshots.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on deleting this blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response on successfully marking for deletion.

DeleteBlobAsync(String, DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteBlobAsync (string blobName, Azure.Storage.Blobs.Models.DeleteSnapshotsOption snapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String blobName

The name of the blob to delete.

DeleteSnapshotsOption snapshotsOption

Specifies options for deleting blob snapshots.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on deleting this blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response on successfully marking for deletion.

DeleteBlobIfExists(String, DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

Declaration

public virtual Azure.Response<bool> DeleteBlobIfExists (string blobName, Azure.Storage.Blobs.Models.DeleteSnapshotsOption snapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String blobName

The name of the blob to delete.

DeleteSnapshotsOption snapshotsOption

Specifies options for deleting blob snapshots.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on deleting this blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<System.Boolean>

A Azure.Response on successfully marking for deletion.

DeleteBlobIfExistsAsync(String, DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<bool>> DeleteBlobIfExistsAsync (string blobName, Azure.Storage.Blobs.Models.DeleteSnapshotsOption snapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String blobName

The name of the blob to delete.

DeleteSnapshotsOption snapshotsOption

Specifies options for deleting blob snapshots.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on deleting this blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<System.Boolean>>

A Azure.Response on successfully marking for deletion.

DeleteIfExists(BlobRequestConditions, CancellationToken)

Declaration

public virtual Azure.Response<bool> DeleteIfExists (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on the deletion of this container.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<System.Boolean>

A Azure.Response Returns true if container exists and was marked for deletion, return false otherwise.

DeleteIfExistsAsync(BlobRequestConditions, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<bool>> DeleteIfExistsAsync (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on the deletion of this container.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<System.Boolean>>

A Azure.Response Returns true if container exists and was marked for deletion, return false otherwise.

Exists(CancellationToken)

Declaration

public virtual Azure.Response<bool> Exists (System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<System.Boolean>

Returns true if the container exists.

ExistsAsync(CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<bool>> ExistsAsync (System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<System.Boolean>>

Returns true if the container exists.

FindBlobsByTags(String, CancellationToken)

FindBlobsByTagsAsync(String, CancellationToken)

GenerateSasUri(BlobSasBuilder)

Declaration

public virtual Uri GenerateSasUri (Azure.Storage.Sas.BlobSasBuilder builder);

Parameters

BlobSasBuilder builder

Used to generate a Shared Access Signature (SAS).

Returns

System.Uri

A Uri containing the SAS Uri.

GenerateSasUri(BlobContainerSasPermissions, DateTimeOffset)

Declaration

public virtual Uri GenerateSasUri (Azure.Storage.Sas.BlobContainerSasPermissions permissions, DateTimeOffset expiresOn);

Parameters

BlobContainerSasPermissions permissions

Required. Specifies the list of permissions to be associated with the SAS. See BlobContainerSasPermissions.

System.DateTimeOffset expiresOn

Required. Specifies the time at which the SAS becomes invalid. This field must be omitted if it has been specified in an associated stored access policy.

Returns

System.Uri

A Uri containing the SAS Uri.

GetAccessPolicy(BlobRequestConditions, CancellationToken)

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContainerAccessPolicy> GetAccessPolicy (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on getting the blob container's access policy.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

GetAccessPolicyAsync(BlobRequestConditions, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContainerAccessPolicy>> GetAccessPolicyAsync (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on getting the blob container's access policy.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobContainerAccessPolicy>>

A Azure.Response describing the container's access policy.

GetAppendBlobClientCore(String)

Declaration

protected internal virtual Azure.Storage.Blobs.Specialized.AppendBlobClient GetAppendBlobClientCore (string blobName);

Parameters

System.String blobName

The name of the append blob.

Returns

GetBlobBaseClientCore(String)

Declaration

protected internal virtual Azure.Storage.Blobs.Specialized.BlobBaseClient GetBlobBaseClientCore (string blobName);

Parameters

System.String blobName

The name of the blob.

Returns

GetBlobClient(String)

Declaration

public virtual Azure.Storage.Blobs.BlobClient GetBlobClient (string blobName);

Parameters

System.String blobName

The name of the blob.

Returns

GetBlobLeaseClientCore(String)

Declaration

protected internal virtual Azure.Storage.Blobs.Specialized.BlobLeaseClient GetBlobLeaseClientCore (string leaseId);

Parameters

System.String leaseId

An optional lease ID. If no lease ID is provided, a random lease ID will be created.

Returns

GetBlobs(BlobTraits, BlobStates, String, CancellationToken)

Declaration

public virtual Azure.Pageable<Azure.Storage.Blobs.Models.BlobItem> GetBlobs (Azure.Storage.Blobs.Models.BlobTraits traits = Azure.Storage.Blobs.Models.BlobTraits.None, Azure.Storage.Blobs.Models.BlobStates states = Azure.Storage.Blobs.Models.BlobStates.None, string prefix = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobTraits traits

Specifies trait options for shaping the blobs.

BlobStates states

Specifies state options for filtering the blobs.

System.String prefix

Specifies a string that filters the results to return only blobs whose name begins with the specified prefix.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Pageable<BlobItem>

An Azure.Pageable of BlobItemdescribing the blobs in the container.

GetBlobsAsync(BlobTraits, BlobStates, String, CancellationToken)

Declaration

public virtual Azure.AsyncPageable<Azure.Storage.Blobs.Models.BlobItem> GetBlobsAsync (Azure.Storage.Blobs.Models.BlobTraits traits = Azure.Storage.Blobs.Models.BlobTraits.None, Azure.Storage.Blobs.Models.BlobStates states = Azure.Storage.Blobs.Models.BlobStates.None, string prefix = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobTraits traits

Specifies trait options for shaping the blobs.

BlobStates states

Specifies state options for filtering the blobs.

System.String prefix

Specifies a string that filters the results to return only blobs whose name begins with the specified prefix.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.AsyncPageable<BlobItem>

An Azure.AsyncPageable describing the blobs in the container.

GetBlobsByHierarchy(BlobTraits, BlobStates, String, String, CancellationToken)

Declaration

public virtual Azure.Pageable<Azure.Storage.Blobs.Models.BlobHierarchyItem> GetBlobsByHierarchy (Azure.Storage.Blobs.Models.BlobTraits traits = Azure.Storage.Blobs.Models.BlobTraits.None, Azure.Storage.Blobs.Models.BlobStates states = Azure.Storage.Blobs.Models.BlobStates.None, string delimiter = null, string prefix = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobTraits traits

Specifies trait options for shaping the blobs.

BlobStates states

Specifies state options for filtering the blobs.

System.String delimiter

A delimiter that can be used to traverse a virtual hierarchy of blobs as though it were a file system. The delimiter may be a single character or a string.Prefix will be returned in place of all blobs whose names begin with the same substring up to the appearance of the delimiter character. The value of a prefix is substring+delimiter, where substring is the common substring that begins one or more blob names, and delimiter is the value of delimiter. You can use the value of prefix to make a subsequent call to list the blobs that begin with this prefix, by specifying the value of the prefix for theprefix.

Note that each BlobPrefix element returned counts toward the maximum result, just as each Blob element does.

System.String prefix

Specifies a string that filters the results to return only blobs whose name begins with the specified prefix.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

GetBlobsByHierarchyAsync(BlobTraits, BlobStates, String, String, CancellationToken)

Declaration

public virtual Azure.AsyncPageable<Azure.Storage.Blobs.Models.BlobHierarchyItem> GetBlobsByHierarchyAsync (Azure.Storage.Blobs.Models.BlobTraits traits = Azure.Storage.Blobs.Models.BlobTraits.None, Azure.Storage.Blobs.Models.BlobStates states = Azure.Storage.Blobs.Models.BlobStates.None, string delimiter = null, string prefix = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobTraits traits

Specifies trait options for shaping the blobs.

BlobStates states

Specifies state options for filtering the blobs.

System.String delimiter

Note that each BlobPrefix element returned counts toward the maximum result, just as each Blob element does.

System.String prefix

Specifies a string that filters the results to return only blobs whose name begins with the specified prefix.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.AsyncPageable<BlobHierarchyItem>

An Azure.AsyncPageable describing the blobs in the container.

GetBlockBlobClientCore(String)

Declaration

protected internal virtual Azure.Storage.Blobs.Specialized.BlockBlobClient GetBlockBlobClientCore (string blobName);

Parameters

System.String blobName

The name of the block blob.

Returns

GetPageBlobClientCore(String)

Declaration

protected internal virtual Azure.Storage.Blobs.Specialized.PageBlobClient GetPageBlobClientCore (string blobName);

Parameters

System.String blobName

The name of the page blob.

Returns

GetParentBlobServiceClientCore()

Declaration

protected internal virtual Azure.Storage.Blobs.BlobServiceClient GetParentBlobServiceClientCore ();

Returns

GetProperties(BlobRequestConditions, CancellationToken)

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContainerProperties> GetProperties (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on getting the blob container's properties.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

GetPropertiesAsync(BlobRequestConditions, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContainerProperties>> GetPropertiesAsync (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on getting the blob container's properties.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobContainerProperties>>

A Azure.Response describing the container and its properties.

SetAccessPolicy(PublicAccessType, IEnumerable<BlobSignedIdentifier>, BlobRequestConditions, CancellationToken)

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo> SetAccessPolicy (Azure.Storage.Blobs.Models.PublicAccessType accessType = Azure.Storage.Blobs.Models.PublicAccessType.None, System.Collections.Generic.IEnumerable<Azure.Storage.Blobs.Models.BlobSignedIdentifier> permissions = null, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

PublicAccessType accessType

System.Collections.Generic.IEnumerable<BlobSignedIdentifier> permissions

Stored access policies that you can use to provide fine grained control over container permissions.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting this blob container's access policy.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

SetAccessPolicyAsync(PublicAccessType, IEnumerable<BlobSignedIdentifier>, BlobRequestConditions, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo>> SetAccessPolicyAsync (Azure.Storage.Blobs.Models.PublicAccessType accessType = Azure.Storage.Blobs.Models.PublicAccessType.None, System.Collections.Generic.IEnumerable<Azure.Storage.Blobs.Models.BlobSignedIdentifier> permissions = null, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

PublicAccessType accessType

System.Collections.Generic.IEnumerable<BlobSignedIdentifier> permissions

Stored access policies that you can use to provide fine grained control over container permissions.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting this blob container's access policy.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobContainerInfo>>

A Azure.Response describing the updated container.

SetMetadata(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

SetMetadataAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

UploadBlob(String, BinaryData, CancellationToken)

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo> UploadBlob (string blobName, BinaryData content, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String blobName

The name of the blob to upload.

System.BinaryData content

A System.BinaryData containing the content to upload.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobContentInfo>

A Azure.Response describing the state of the updated block blob.

UploadBlob(String, Stream, CancellationToken)

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo> UploadBlob (string blobName, System.IO.Stream content, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String blobName

The name of the blob to upload.

System.IO.Stream content

A System.IO.Stream containing the content to upload.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobContentInfo>

A Azure.Response describing the state of the updated block blob.

UploadBlobAsync(String, BinaryData, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>> UploadBlobAsync (string blobName, BinaryData content, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String blobName

The name of the blob to upload.

System.BinaryData content

A System.BinaryData containing the content to upload.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobContentInfo>>

A Azure.Response describing the state of the updated block blob.

UploadBlobAsync(String, Stream, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>> UploadBlobAsync (string blobName, System.IO.Stream content, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String blobName

The name of the blob to upload.

System.IO.Stream content

A System.IO.Stream containing the content to upload.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobContentInfo>>

A Azure.Response describing the state of the updated block blob.