C# Class Microsoft.WindowsAzure.StorageClient.CloudBlobContainer

Represents a container in the Windows Azure Blob service.
Show file Open project: richorama/azure-sdk-for-mono Class Usage Examples

Private Properties

Property Type Description
CloudBlobContainer System
CloudBlobContainer System
CloudBlobContainer System
CloudBlobContainer System
CreateContainerIfNotExistImpl System.Collections.Generic.IEnumerable
CreateContainerImpl System.Collections.Generic.IEnumerable
DeleteContainerImpl System.Collections.Generic.IEnumerable
EndCreate void
EndCreateIfNotExist bool
EndDelete void
EndFetchAttributes void
EndGetPermissions Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions
EndListBlobsSegmented ResultSegment
EndSetMetadata void
EndSetPermissions void
FetchAttributesImpl System.Collections.Generic.IEnumerable
GetBlobAbsoluteUri string
GetContainerAcl Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions
GetPermissionsImpl System.Collections.Generic.IEnumerable
GetSharedAccessCanonicalName string
ListBlobsImpl System.Collections.Generic.IEnumerable
ListBlobsImplCore System.Collections.Generic.IEnumerable
ParseQueryAndVerify void
SetMetadataImpl System.Collections.Generic.IEnumerable
SetPermissionsImpl System.Collections.Generic.IEnumerable

Public Methods

Method Description
BeginCreate ( AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous operation to create a container.

BeginCreate ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous operation to create a container.

BeginCreateIfNotExist ( AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous request to create the container if it does not already exist.

BeginCreateIfNotExist ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous request to create the container if it does not already exist.

BeginDelete ( AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous operation to delete a container.

BeginDelete ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous operation to delete a container.

BeginFetchAttributes ( AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous operation to retrieve the container's attributes.

BeginFetchAttributes ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous operation to retrieve the container's attributes.

BeginGetPermissions ( AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous request to get the permissions settings for the container.

BeginGetPermissions ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous request to get the permissions settings for the container.

BeginListBlobsSegmented ( AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.

BeginListBlobsSegmented ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.

BeginListBlobsSegmented ( int maxResults, Microsoft.WindowsAzure.StorageClient.ResultContinuation continuationToken, BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.

BeginSetMetadata ( AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous operation to set user-defined metadata on the container.

BeginSetMetadata ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous operation to set user-defined metadata on the container.

BeginSetPermissions ( Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions permissions, AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous request to set permissions for the container.

BeginSetPermissions ( Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions permissions, BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult

Begins an asynchronous request to set permissions for the container.

CloudBlobContainer ( string containerAddress ) : System

Initializes a new instance of the CloudBlobContainer class.

CloudBlobContainer ( string containerAddress, CloudBlobClient service ) : System

Initializes a new instance of the CloudBlobContainer class.

CloudBlobContainer ( string containerAddress, StorageCredentials credentials ) : System

Initializes a new instance of the CloudBlobContainer class.

Create ( ) : void

Creates the container.

Create ( BlobRequestOptions options ) : void

Creates the container.

CreateIfNotExist ( ) : bool

Creates the container if it does not already exist.

CreateIfNotExist ( BlobRequestOptions options ) : bool

Creates the container if it does not already exist.

Delete ( ) : void

Deletes the container.

Delete ( BlobRequestOptions options ) : void

Deletes the container.

FetchAttributes ( ) : void

Retrieves the container's attributes.

FetchAttributes ( BlobRequestOptions options ) : void

Retrieves the container's attributes.

GetBlobReference ( string blobAddressUri ) : CloudBlob

Gets a reference to a blob in this container.

GetBlockBlobReference ( string blobAddressUri ) : CloudBlockBlob

Gets a reference to a block blob in this container.

GetDirectoryReference ( string relativeAddress ) : Microsoft.WindowsAzure.StorageClient.CloudBlobDirectory

Gets a reference to a virtual blob directory beneath this container.

GetPageBlobReference ( string blobAddressUri ) : Microsoft.WindowsAzure.StorageClient.CloudPageBlob

Gets a reference to a page blob in this container.

GetPermissions ( ) : Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions

Gets the permissions settings for the container.

GetPermissions ( BlobRequestOptions options ) : Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions

Gets the permissions settings for the container.

GetSharedAccessSignature ( Microsoft.WindowsAzure.StorageClient.SharedAccessPolicy policy ) : string

Returns a shared access signature for the container.

GetSharedAccessSignature ( Microsoft.WindowsAzure.StorageClient.SharedAccessPolicy policy, string groupPolicyIdentifier ) : string

Returns a shared access signature for the container.

ListBlobs ( ) : IEnumerable

Returns an enumerable collection of the blobs in the container.

ListBlobs ( BlobRequestOptions options ) : IEnumerable

Returns an enumerable collection of the blobs in the container that are retrieved lazily.

ListBlobsSegmented ( BlobRequestOptions options ) : ResultSegment

Returns a result segment containing a collection of blob items in the container.

ListBlobsSegmented ( int maxResults, Microsoft.WindowsAzure.StorageClient.ResultContinuation continuationToken, BlobRequestOptions options ) : ResultSegment

Returns a result segment containing a collection of blob items in the container.

SetMetadata ( ) : void

Sets the container's user-defined metadata.

SetMetadata ( BlobRequestOptions options ) : void

Sets the container's user-defined metadata.

SetPermissions ( Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions permissions ) : void

Sets permissions for the container.

SetPermissions ( Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions permissions, BlobRequestOptions options ) : void

Sets permissions for the container.

Private Methods

Method Description
CloudBlobContainer ( Microsoft.WindowsAzure.StorageClient.BlobContainerAttributes attrib, CloudBlobClient client ) : System

Initializes a new instance of the CloudBlobContainer class.

CloudBlobContainer ( bool usePathStyleUris, string containerAddress ) : System

Initializes a new instance of the CloudBlobContainer class.

CloudBlobContainer ( string containerAddress, StorageCredentials credentials, bool usePathStyleUris ) : System

Initializes a new instance of the CloudBlobContainer class.

CloudBlobContainer ( string containerAddress, bool usePathStyleUris ) : System

Initializes a new instance of the CloudBlobContainer class with the given address and path style Uri preference.

CreateContainerIfNotExistImpl ( BlobRequestOptions options, Action setResult ) : System.Collections.Generic.IEnumerable

Implementation for the CreateIfNotExist method.

CreateContainerImpl ( BlobRequestOptions options ) : System.Collections.Generic.IEnumerable

Implementation for the Create method.

DeleteContainerImpl ( BlobRequestOptions options ) : System.Collections.Generic.IEnumerable

Implementation for the Delete method.

EndCreate ( IAsyncResult asyncResult ) : void
EndCreateIfNotExist ( IAsyncResult asyncResult ) : bool
EndDelete ( IAsyncResult asyncResult ) : void
EndFetchAttributes ( IAsyncResult asyncResult ) : void
EndGetPermissions ( IAsyncResult asyncResult ) : Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions
EndListBlobsSegmented ( IAsyncResult asyncResult ) : ResultSegment
EndSetMetadata ( IAsyncResult asyncResult ) : void
EndSetPermissions ( IAsyncResult asyncResult ) : void
FetchAttributesImpl ( BlobRequestOptions options ) : System.Collections.Generic.IEnumerable

Implementation for the FetchAttributes method.

GetBlobAbsoluteUri ( string blobName ) : string

Gets the absolute Uri of the blob.

GetContainerAcl ( string aclstring ) : Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions

Converts the ACL string to a BlobContainerPermissions object.

GetPermissionsImpl ( BlobRequestOptions options, Action setResult ) : System.Collections.Generic.IEnumerable

Implementation for the GetPermissions method.

GetSharedAccessCanonicalName ( ) : string

Returns the canonical name for shared access.

ListBlobsImpl ( string prefix, BlobRequestOptions options, Microsoft.WindowsAzure.StorageClient.ResultContinuation continuationToken, int maxResults, Action setResult ) : System.Collections.Generic.IEnumerable

Implementation for the ListBlobs method.

ListBlobsImplCore ( string prefix, BlobRequestOptions options, Microsoft.WindowsAzure.StorageClient.ResultContinuation continuationToken, Microsoft.WindowsAzure.StorageClient.ResultPagination pagination, Action setResult ) : System.Collections.Generic.IEnumerable

Core implementation of the ListBlobs method.

ParseQueryAndVerify ( Uri completeUri, CloudBlobClient existingClient, bool usePathStyleUris ) : void

Parse Uri for SAS (Shared access signature) information.

Validate that no other query parameters are passed in. Any SAS information will be recorded as corresponding credentials instance. If existingClient is passed in, any SAS information found will not be supported. Otherwise a new client is created based on SAS information or as anonymous credentials.

SetMetadataImpl ( BlobRequestOptions options ) : System.Collections.Generic.IEnumerable

Implementation for the SetMetadata method.

SetPermissionsImpl ( Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions acl, BlobRequestOptions options ) : System.Collections.Generic.IEnumerable

Implementation for the SetPermissions method.

Method Details

BeginCreate() public method

Begins an asynchronous operation to create a container.
public BeginCreate ( AsyncCallback callback, object state ) : IAsyncResult
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginCreate() public method

Begins an asynchronous operation to create a container.
public BeginCreate ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult
options BlobRequestOptions An object that specifies any additional options for the request.
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginCreateIfNotExist() public method

Begins an asynchronous request to create the container if it does not already exist.
public BeginCreateIfNotExist ( AsyncCallback callback, object state ) : IAsyncResult
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginCreateIfNotExist() public method

Begins an asynchronous request to create the container if it does not already exist.
public BeginCreateIfNotExist ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult
options BlobRequestOptions An object that specifies any additional options for the request.
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginDelete() public method

Begins an asynchronous operation to delete a container.
public BeginDelete ( AsyncCallback callback, object state ) : IAsyncResult
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginDelete() public method

Begins an asynchronous operation to delete a container.
public BeginDelete ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult
options BlobRequestOptions An object that specifies any additional options for the request.
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginFetchAttributes() public method

Begins an asynchronous operation to retrieve the container's attributes.
public BeginFetchAttributes ( AsyncCallback callback, object state ) : IAsyncResult
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginFetchAttributes() public method

Begins an asynchronous operation to retrieve the container's attributes.
public BeginFetchAttributes ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult
options BlobRequestOptions An object that specifies any additional options for the request.
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginGetPermissions() public method

Begins an asynchronous request to get the permissions settings for the container.
public BeginGetPermissions ( AsyncCallback callback, object state ) : IAsyncResult
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginGetPermissions() public method

Begins an asynchronous request to get the permissions settings for the container.
public BeginGetPermissions ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult
options BlobRequestOptions An object that specifies any additional options for the request.
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginListBlobsSegmented() public method

Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.
public BeginListBlobsSegmented ( AsyncCallback callback, object state ) : IAsyncResult
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginListBlobsSegmented() public method

Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.
public BeginListBlobsSegmented ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult
options BlobRequestOptions An object that specifies any additional options for the request.
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginListBlobsSegmented() public method

Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.
public BeginListBlobsSegmented ( int maxResults, Microsoft.WindowsAzure.StorageClient.ResultContinuation continuationToken, BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult
maxResults int A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the /// per-operation limit of 5000. If this value is zero, the maximum possible number of results will be returned, up to 5000.
continuationToken Microsoft.WindowsAzure.StorageClient.ResultContinuation A continuation token returned by a previous listing operation.
options BlobRequestOptions An object that specifies any additional options for the request.
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginSetMetadata() public method

Begins an asynchronous operation to set user-defined metadata on the container.
public BeginSetMetadata ( AsyncCallback callback, object state ) : IAsyncResult
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginSetMetadata() public method

Begins an asynchronous operation to set user-defined metadata on the container.
public BeginSetMetadata ( BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult
options BlobRequestOptions An object that specifies any additional options for the request.
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginSetPermissions() public method

Begins an asynchronous request to set permissions for the container.
public BeginSetPermissions ( Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions permissions, AsyncCallback callback, object state ) : IAsyncResult
permissions Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions The permissions to apply to the container.
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

BeginSetPermissions() public method

Begins an asynchronous request to set permissions for the container.
public BeginSetPermissions ( Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions permissions, BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult
permissions Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions The permissions to apply to the container.
options BlobRequestOptions An object that specifies any additional options for the request.
callback AsyncCallback The callback delegate that will receive notification when the asynchronous operation completes.
state object A user-defined object that will be passed to the callback delegate.
return IAsyncResult

CloudBlobContainer() public method

Initializes a new instance of the CloudBlobContainer class.
public CloudBlobContainer ( string containerAddress ) : System
containerAddress string The absolute URI to the container.
return System

CloudBlobContainer() public method

Initializes a new instance of the CloudBlobContainer class.
public CloudBlobContainer ( string containerAddress, CloudBlobClient service ) : System
containerAddress string Either the absolute URI to the container, or the container name.
service CloudBlobClient A client object that specifies the endpoint for the Blob service.
return System

CloudBlobContainer() public method

Initializes a new instance of the CloudBlobContainer class.
public CloudBlobContainer ( string containerAddress, StorageCredentials credentials ) : System
containerAddress string The absolute URI to the container.
credentials StorageCredentials The account credentials.
return System

Create() public method

Creates the container.
public Create ( ) : void
return void

Create() public method

Creates the container.
public Create ( BlobRequestOptions options ) : void
options BlobRequestOptions An object that specifies any additional options for the request.
return void

CreateIfNotExist() public method

Creates the container if it does not already exist.
public CreateIfNotExist ( ) : bool
return bool

CreateIfNotExist() public method

Creates the container if it does not already exist.
public CreateIfNotExist ( BlobRequestOptions options ) : bool
options BlobRequestOptions An object that specifies any additional options for the request.
return bool

Delete() public method

Deletes the container.
public Delete ( ) : void
return void

Delete() public method

Deletes the container.
public Delete ( BlobRequestOptions options ) : void
options BlobRequestOptions An object that specifies any additional options for the request.
return void

FetchAttributes() public method

Retrieves the container's attributes.
public FetchAttributes ( ) : void
return void

FetchAttributes() public method

Retrieves the container's attributes.
public FetchAttributes ( BlobRequestOptions options ) : void
options BlobRequestOptions An object that specifies any additional options for the request.
return void

GetBlobReference() public method

Gets a reference to a blob in this container.
public GetBlobReference ( string blobAddressUri ) : CloudBlob
blobAddressUri string The name of the blob, or the absolute URI to the blob.
return CloudBlob

GetBlockBlobReference() public method

Gets a reference to a block blob in this container.
public GetBlockBlobReference ( string blobAddressUri ) : CloudBlockBlob
blobAddressUri string The name of the blob, or the absolute URI to the blob.
return CloudBlockBlob

GetDirectoryReference() public method

Gets a reference to a virtual blob directory beneath this container.
public GetDirectoryReference ( string relativeAddress ) : Microsoft.WindowsAzure.StorageClient.CloudBlobDirectory
relativeAddress string The name of the virtual blob directory, or the absolute URI to the virtual blob directory.
return Microsoft.WindowsAzure.StorageClient.CloudBlobDirectory

GetPageBlobReference() public method

Gets a reference to a page blob in this container.
public GetPageBlobReference ( string blobAddressUri ) : Microsoft.WindowsAzure.StorageClient.CloudPageBlob
blobAddressUri string The name of the blob, or the absolute URI to the blob.
return Microsoft.WindowsAzure.StorageClient.CloudPageBlob

GetPermissions() public method

Gets the permissions settings for the container.
public GetPermissions ( ) : Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions
return Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions

GetPermissions() public method

Gets the permissions settings for the container.
public GetPermissions ( BlobRequestOptions options ) : Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions
options BlobRequestOptions An object that specifies any additional options for the request.
return Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions

GetSharedAccessSignature() public method

Returns a shared access signature for the container.
public GetSharedAccessSignature ( Microsoft.WindowsAzure.StorageClient.SharedAccessPolicy policy ) : string
policy Microsoft.WindowsAzure.StorageClient.SharedAccessPolicy The access policy for the shared access signature.
return string

GetSharedAccessSignature() public method

Returns a shared access signature for the container.
public GetSharedAccessSignature ( Microsoft.WindowsAzure.StorageClient.SharedAccessPolicy policy, string groupPolicyIdentifier ) : string
policy Microsoft.WindowsAzure.StorageClient.SharedAccessPolicy The access policy for the shared access signature.
groupPolicyIdentifier string A container-level access policy.
return string

ListBlobs() public method

Returns an enumerable collection of the blobs in the container.
public ListBlobs ( ) : IEnumerable
return IEnumerable

ListBlobs() public method

Returns an enumerable collection of the blobs in the container that are retrieved lazily.
public ListBlobs ( BlobRequestOptions options ) : IEnumerable
options BlobRequestOptions An object that specifies any additional options for the request.
return IEnumerable

ListBlobsSegmented() public method

Returns a result segment containing a collection of blob items in the container.
public ListBlobsSegmented ( BlobRequestOptions options ) : ResultSegment
options BlobRequestOptions An object that specifies any additional options for the request.
return ResultSegment

ListBlobsSegmented() public method

Returns a result segment containing a collection of blob items in the container.
public ListBlobsSegmented ( int maxResults, Microsoft.WindowsAzure.StorageClient.ResultContinuation continuationToken, BlobRequestOptions options ) : ResultSegment
maxResults int A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the /// per-operation limit of 5000. If this value is zero, the maximum possible number of results will be returned, up to 5000.
continuationToken Microsoft.WindowsAzure.StorageClient.ResultContinuation A continuation token returned by a previous listing operation.
options BlobRequestOptions An object that specifies any additional options for the request.
return ResultSegment

SetMetadata() public method

Sets the container's user-defined metadata.
public SetMetadata ( ) : void
return void

SetMetadata() public method

Sets the container's user-defined metadata.
public SetMetadata ( BlobRequestOptions options ) : void
options BlobRequestOptions An object that specifies any additional options for the request.
return void

SetPermissions() public method

Sets permissions for the container.
public SetPermissions ( Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions permissions ) : void
permissions Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions The permissions to apply to the container.
return void

SetPermissions() public method

Sets permissions for the container.
public SetPermissions ( Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions permissions, BlobRequestOptions options ) : void
permissions Microsoft.WindowsAzure.StorageClient.BlobContainerPermissions The permissions to apply to the container.
options BlobRequestOptions An object that specifies any additional options for the request.
return void