AZSCloudBlobContainer Class Reference

Inherits from NSObject
Declared in AZSCloudBlobContainer.h
AZSCloudBlobContainer.m

Overview

AZSCloudBlobContainer represents a Blob Container object on the Storage Service.

A blob container is a logical container object for blobs on the Azure Storage Service. An instance of this class is used to interface with the corresponding container on the service.

Other Methods

– initWithUrl:error:

Initializes a newly allocated AZSCloudBlobContainer object.

- (instancetype)initWithUrl:(NSURL *)containerAbsoluteUrl error:(NSError **)error

Parameters

containerAbsoluteUrl

The absolute URL to this container.
error

A pointer to a NSError*, to be set in the event of failure.

Return Value

The newly allocated object.

Discussion

Initializes a newly allocated AZSCloudBlobContainer object.

Declared In

AZSCloudBlobContainer.h

– initWithUrl:credentials:error:

Initializes a newly allocated AZSCloudBlobContainer object.

- (instancetype)initWithUrl:(NSURL *)containerAbsoluteUrl credentials:(AZSStorageCredentials *)credentials error:(NSError **)error

Parameters

containerAbsoluteUrl

The absolute URL to this container.
credentials

The AZSStorageCredentials used to authenticate to the container.
error

A pointer to a NSError*, to be set in the event of failure.

Return Value

The newly allocated object.

Discussion

Initializes a newly allocated AZSCloudBlobContainer object.

Declared In

AZSCloudBlobContainer.h

– initWithStorageUri:error:

Initializes a newly allocated AZSCloudBlobContainer object.

- (instancetype)initWithStorageUri:(AZSStorageUri *)containerAbsoluteUri error:(NSError **)error

Parameters

containerAbsoluteUri

The StorageURI to this container.
error

A pointer to a NSError*, to be set in the event of failure.

Return Value

The newly allocated object.

Discussion

Initializes a newly allocated AZSCloudBlobContainer object.

Declared In

AZSCloudBlobContainer.h

– initWithStorageUri:credentials:error:

Initializes a newly allocated AZSCloudBlobContainer object.

- (instancetype)initWithStorageUri:(AZSStorageUri *)containerAbsoluteUri credentials:(AZSStorageCredentials *)credentials error:(NSError **)error

Parameters

containerAbsoluteUri

The StorageURI to this container.
credentials

The AZSStorageCredentials used to authenticate to the container.
error

A pointer to a NSError*, to be set in the event of failure.

Return Value

The newly allocated object.

Discussion

Initializes a newly allocated AZSCloudBlobContainer object.

Declared In

AZSCloudBlobContainer.h

– initWithName:client:

Initializes a newly allocated AZSCloudBlobContainer object.

- (instancetype)initWithName:(NSString *)containerName client:(AZSCloudBlobClient *)client

Parameters

containerName

The name of this container.
client

The AZSCloudBlobClient representing the blob service that this container is in.

Return Value

The newly allocated object.

Discussion

Initializes a newly allocated AZSCloudBlobContainer object.

Declared In

AZSCloudBlobContainer.h

– createContainerWithCompletionHandler:

Creates the container on the service. Will fail if the container already exists.

- (void)createContainerWithCompletionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

completionHandler

The block of code to execute when the create call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Creates the container on the service. Will fail if the container already exists.

Declared In

AZSCloudBlobContainer.h

– createContainerWithAccessType:requestOptions:operationContext:completionHandler:

Creates the container on the service. Will fail if the container already exists.

- (void)createContainerWithAccessType:(AZSContainerPublicAccessType)accessType requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

accessType

The access type that the container should have.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the create call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Creates the container on the service. Will fail if the container already exists.

Declared In

AZSCloudBlobContainer.h

– deleteContainerWithCompletionHandler:

Deletes the container on the service. Will fail if the container does not exist.

- (void)deleteContainerWithCompletionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

completionHandler

The block of code to execute when the delete call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Deletes the container on the service. Will fail if the container does not exist.

Declared In

AZSCloudBlobContainer.h

– deleteContainerWithAccessCondition:requestOptions:operationContext:completionHandler:

Deletes the container on the service. Will fail if the container does not exist.

- (void)deleteContainerWithAccessCondition:(AZSAccessCondition *)accessCondition requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the delete call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Deletes the container on the service. Will fail if the container does not exist.

Declared In

AZSCloudBlobContainer.h

– listBlobsSegmentedWithContinuationToken:prefix:useFlatBlobListing:blobListingDetails:maxResults:completionHandler:

Performs one segmented blob listing operation.

- (void)listBlobsSegmentedWithContinuationToken:(AZSContinuationToken *)token prefix:(NSString *)prefix useFlatBlobListing:(BOOL)useFlatBlobListing blobListingDetails:(AZSBlobListingDetails)blobListingDetails maxResults:(NSInteger)maxResults completionHandler:(void ( ^ ) ( NSError *, AZSBlobResultSegment *))completionHandler

Parameters

token

The token representing where the listing operation should start.
prefix

The prefix to use for blob listing. Only blobs that begin with the input prefix will be listed.
useFlatBlobListing

YES if the blob list should be flat (list all blobs as if their names were only strings, no directories). NO if it should list with directories.
blobListingDetails

Details about how to list blobs. See AZSBlobListingDetails for the possible options.
maxResults

The maximum number of results to return for this operation. Use -1 to not set a limit.
completionHandler

The block of code to execute with the results of the listing operation.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
AZSBlobResultSegment * The blob result segment containing the result of the listing operation.

Discussion

Performs one segmented blob listing operation.

This method lists the blobs in the given container. It will perform exactly one REST call, which will list blobs beginning with the blob represented in the AZSContinuationToken. If no token is provided, it will list blobs from the beginning. Only blobs that begin with the input prefix will be listed.

Any number of blobs can be listed, from zero up to a set maximum. Even if this method returns zero results, if the AZSContinuationToken in the result is not nil, there may be more blobs on the service that have not been listed.

Declared In

AZSCloudBlobContainer.h

– listBlobsSegmentedWithContinuationToken:prefix:useFlatBlobListing:blobListingDetails:maxResults:accessCondition:requestOptions:operationContext:completionHandler:

Performs one segmented blob listing operation.

- (void)listBlobsSegmentedWithContinuationToken:(AZSContinuationToken *)token prefix:(NSString *)prefix useFlatBlobListing:(BOOL)useFlatBlobListing blobListingDetails:(AZSBlobListingDetails)blobListingDetails maxResults:(NSInteger)maxResults accessCondition:(AZSAccessCondition *)accessCondition requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *, AZSBlobResultSegment *))completionHandler

Parameters

token

The token representing where the listing operation should start.
prefix

The prefix to use for blob listing. Only blobs that begin with the input prefix will be listed.
useFlatBlobListing

YES if the blob list should be flat (list all blobs as if their names were only strings, no directories). NO if it should list with directories.
blobListingDetails

Details about how to list blobs. See AZSBlobListingDetails for the possible options.
maxResults

The maximum number of results to return for this operation. Use -1 to not set a limit.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute with the results of the listing operation.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
AZSBlobResultSegment * The blob result segment containing the result of the listing operation.

Discussion

Performs one segmented blob listing operation.

This method lists the blobs in the given container. It will perform exactly one REST call, which will list blobs beginning with the blob represented in the AZSContinuationToken. If no token is provided, it will list blobs from the beginning. Only blobs that begin with the input prefix will be listed.

Any number of blobs can be listed, from zero up to a set maximum. Even if this method returns zero results, if the AZSContinuationToken in the result is not nil, there may be more blobs on the service that have not been listed.

Declared In

AZSCloudBlobContainer.h

– uploadMetadataWithCompletionHandler:

Sets the container’s user defined metadata.

- (void)uploadMetadataWithCompletionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

completionHandler

The block of code to execute when the Upload Metadata call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Sets the container’s user defined metadata.

Declared In

AZSCloudBlobContainer.h

– uploadMetadataWithAccessCondition:requestOptions:operationContext:completionHandler:

Sets the container’s user defined metadata.

- (void)uploadMetadataWithAccessCondition:(AZSAccessCondition *)accessCondition requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Upload Metadata call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Sets the container’s user defined metadata.

Declared In

AZSCloudBlobContainer.h

– uploadPermissions:completionHandler:

Uploads a set of permissions for the container.

- (void)uploadPermissions:(NSMutableDictionary *)permissions completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

permissions

The permissions to upload.
completionHandler

The block of code to execute when the Upload Permissions call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Uploads a set of permissions for the container.

Declared In

AZSCloudBlobContainer.h

– uploadPermissions:publicAccess:accessCondition:requestOptions:operationContext:completionHandler:

Uploads a set of permissions for the container.

- (void)uploadPermissions:(NSMutableDictionary *)permissions publicAccess:(AZSContainerPublicAccessType)publicAccess accessCondition:(AZSAccessCondition *)accessCondition requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

permissions

The permissions to upload.
publicAccess

The public access level for the container.
accessCondition

The access conditions for the container.
requestOptions

Specifies any additional options for the request. Specifying nil will use the default request options from the associated client.
operationContext

Represents the context for the current operation. Can be used to track requests to the storage service, and to provide additional runtime information about the operation.
completionHandler

The block of code to execute when the Upload Permissions call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Uploads a set of permissions for the container.

Declared In

AZSCloudBlobContainer.h

– downloadAttributesWithCompletionHandler:

Retrieves the container’s attributes.

- (void)downloadAttributesWithCompletionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

completionHandler

The block of code to execute when the Fetch Attributes call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Retrieves the container’s attributes.

Declared In

AZSCloudBlobContainer.h

– downloadAttributesWithAccessCondition:requestOptions:operationContext:completionHandler:

Retrieves the container’s attributes.

- (void)downloadAttributesWithAccessCondition:(AZSAccessCondition *)accessCondition requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Fetch Attributes call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Retrieves the container’s attributes.

Declared In

AZSCloudBlobContainer.h

– downloadPermissionsWithCompletionHandler:

Retrieves the stored container permissions.

- (void)downloadPermissionsWithCompletionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSMutableDictionary *, AZSContainerPublicAccessType ))completionHandler

Parameters

completionHandler

The block of code to execute when the Download Permissions call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Retrieves the stored container permissions.

Declared In

AZSCloudBlobContainer.h

– downloadPermissionsWithAccessCondition:requestOptions:operationContext:completionHandler:

Retrieves the stored container permissions.

- (void)downloadPermissionsWithAccessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSMutableDictionary *, AZSContainerPublicAccessType ))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Download Permissions call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Retrieves the stored container permissions.

Declared In

AZSCloudBlobContainer.h

– acquireLeaseWithLeaseTime:proposedLeaseId:completionHandler:

Acquires a lease on this container.

- (void)acquireLeaseWithLeaseTime:(NSNumber *)leaseTime proposedLeaseId:(NSString *)proposedLeaseId completionHandler:(void ( ^ ) ( NSError *, NSString *))completionHandler

Parameters

leaseTime

The span of time for which to acquire the lease, rounded down to seconds. If NIL, an infinite lease will be acquired. Must be greater than zero.
proposedLeaseId

The proposed lease ID for the new lease, or NIL if no lease ID is proposed.
completionHandler

The block of code to execute when the Acquire Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The ID of the acquired lease.

Discussion

Acquires a lease on this container.

Declared In

AZSCloudBlobContainer.h

– acquireLeaseWithLeaseTime:proposedLeaseId:accessCondition:requestOptions:operationContext:completionHandler:

Acquires a lease on this container.

- (void)acquireLeaseWithLeaseTime:(NSNumber *)leaseTime proposedLeaseId:(NSString *)proposedLeaseId accessCondition:(AZSAccessCondition *)accessCondition requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *, NSString *))completionHandler

Parameters

leaseTime

The span of time for which to acquire the lease, rounded down to seconds. If NIL, an infinite lease will be acquired. Must be greater than zero.
proposedLeaseId

The proposed lease ID for the new lease, or NIL if no lease ID is proposed.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Acquire Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The ID of the acquired lease.

Discussion

Acquires a lease on this container.

Declared In

AZSCloudBlobContainer.h

– breakLeaseWithBreakPeriod:completionHandler:

Breaks the current lease on this container.

- (void)breakLeaseWithBreakPeriod:(NSNumber *)breakPeriod completionHandler:(void ( ^ ) ( NSError *, NSNumber *))completionHandler

Parameters

breakPeriod

The span of time for which to allow the lease to remain, rounded down to seconds. If NIL, the break period will be the remainder of the current lease or zero for an infinite lease.
completionHandler

The block of code to execute when the Break Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSNumber * The amount of time before the lease ends, to the second.

Discussion

Breaks the current lease on this container.

Declared In

AZSCloudBlobContainer.h

– breakLeaseWithBreakPeriod:accessCondition:requestOptions:operationContext:completionHandler:

Breaks the current lease on this container.

- (void)breakLeaseWithBreakPeriod:(NSNumber *)breakPeriod accessCondition:(AZSAccessCondition *)accessCondition requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *, NSNumber *))completionHandler

Parameters

breakPeriod

The span of time for which to allow the lease to remain, rounded down to seconds. If NIL, the break period will be the remainder of the current lease or zero for an infinite lease.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Break Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSNumber * The amount of time before the lease ends, to the second.

Discussion

Breaks the current lease on this container.

Declared In

AZSCloudBlobContainer.h

– changeLeaseWithProposedLeaseId:accessCondition:completionHandler:

Changes the lease ID on this container.

- (void)changeLeaseWithProposedLeaseId:(NSString *)proposedLeaseId accessCondition:(AZSAccessCondition *)accessCondition completionHandler:(void ( ^ ) ( NSError *, NSString *))completionHandler

Parameters

proposedLeaseId

The proposed lease ID for the new lease, which cannot be null.
accessCondition

The access condition for the request.
completionHandler

The block of code to execute when the Change Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The new lease ID.

Discussion

Changes the lease ID on this container.

Declared In

AZSCloudBlobContainer.h

– changeLeaseWithProposedLeaseId:accessCondition:requestOptions:operationContext:completionHandler:

Changes the lease ID on this container.

- (void)changeLeaseWithProposedLeaseId:(NSString *)proposedLeaseId accessCondition:(AZSAccessCondition *)accessCondition requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *, NSString *))completionHandler

Parameters

proposedLeaseId

The proposed lease ID for the new lease, which cannot be null.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Change Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The new lease ID.

Discussion

Changes the lease ID on this container.

Declared In

AZSCloudBlobContainer.h

– releaseLeaseWithAccessCondition:completionHandler:

Releases the lease on this container.

- (void)releaseLeaseWithAccessCondition:(AZSAccessCondition *)accessCondition completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

accessCondition

The access condition for the request.
completionHandler

The block of code to execute when the Release Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Releases the lease on this container.

Declared In

AZSCloudBlobContainer.h

– releaseLeaseWithAccessCondition:requestOptions:operationContext:completionHandler:

Releases the lease on this container.

- (void)releaseLeaseWithAccessCondition:(AZSAccessCondition *)accessCondition requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Release Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Releases the lease on this container.

Declared In

AZSCloudBlobContainer.h

– renewLeaseWithAccessCondition:completionHandler:

Renews a lease on this container.

- (void)renewLeaseWithAccessCondition:(AZSAccessCondition *)accessCondition completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

accessCondition

The access condition for the request.
completionHandler

The block of code to execute when the Renew Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Renews a lease on this container.

Declared In

AZSCloudBlobContainer.h

– renewLeaseWithAccessCondition:requestOptions:operationContext:completionHandler:

Renews a lease on this container.

- (void)renewLeaseWithAccessCondition:(AZSAccessCondition *)accessCondition requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Renew Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Renews a lease on this container.

Declared In

AZSCloudBlobContainer.h

– blockBlobReferenceFromName:

Initialize a local AZSCloudBlockBlob object

- (AZSCloudBlockBlob *)blockBlobReferenceFromName:(NSString *)blobName

Parameters

blobName

The name of the block blob (part of the URL)

Return Value

The newly allocated block blob object.

Discussion

Initialize a local AZSCloudBlockBlob object

This creates an AZSCloudBlockBlob object with the input name.

TODO: Consider renaming this ‘blockBlobFromName’. This is better Objective-C style, but may confuse users into thinking that this method creates a blob on the service, which is does not.

Warning: This method does not make a service call. If properties, metadata, etc have been set on the service for this blob, this will not be reflected in the local container object.

Declared In

AZSCloudBlobContainer.h

– blockBlobReferenceFromName:snapshotTime:

Initialize a local AZSCloudBlockBlob object

- (AZSCloudBlockBlob *)blockBlobReferenceFromName:(NSString *)blobName snapshotTime:(NSString *)snapshotTime

Parameters

blobName

The name of the block blob (part of the URL)
snapshotTime

The snapshot time for the blob. Nil means the root blob (not a snapshot).

Return Value

The newly allocated block blob object.

Discussion

Initialize a local AZSCloudBlockBlob object

This creates an AZSCloudBlockBlob object with the input name.

TODO: Consider renaming this ‘blockBlobFromName’. This is better Objective-C style, but may confuse users into thinking that this method creates a blob on the service, which is does not.

Warning: This method does not make a service call. If properties, metadata, etc have been set on the service for this blob, this will not be reflected in the local container object.

Declared In

AZSCloudBlobContainer.h

– pageBlobReferenceFromName:

Initialize a local AZSCloudPageBlob object

- (AZSCloudPageBlob *)pageBlobReferenceFromName:(NSString *)blobName

Parameters

blobName

The name of the page blob (part of the URL)

Return Value

The new page blob object.

Discussion

Initialize a local AZSCloudPageBlob object

This creates an AZSCloudPageBlob object with the input name.

Warning: This method does not make a service call. If properties, metadata, etc have been set on the service for this blob, this will not be reflected in the local container object.

Declared In

AZSCloudBlobContainer.h

– pageBlobReferenceFromName:snapshotTime:

Initialize a local AZSCloudPageBlob object

- (AZSCloudPageBlob *)pageBlobReferenceFromName:(NSString *)blobName snapshotTime:(NSString *)snapshotTime

Parameters

blobName

The name of the page blob (part of the URL)
snapshotTime

The snapshot time for the blob. Nil means the root blob (not a snapshot).

Return Value

The new page blob object.

Discussion

Initialize a local AZSCloudPageBlob object

This creates an AZSCloudPageBlob object with the input name.

Warning: This method does not make a service call. If properties, metadata, etc have been set on the service for this blob, this will not be reflected in the local container object.

Declared In

AZSCloudBlobContainer.h

– appendBlobReferenceFromName:

Initialize a local AZSCloudAppendBlob object

- (AZSCloudAppendBlob *)appendBlobReferenceFromName:(NSString *)blobName

Parameters

blobName

The name of the append blob (part of the URL)

Return Value

The new append blob object.

Discussion

Initialize a local AZSCloudAppendBlob object

This creates an AZSCloudAppendBlob object with the input name.

Warning: This method does not make a service call. If properties, metadata, etc have been set on the service for this blob, this will not be reflected in the local container object.

Declared In

AZSCloudBlobContainer.h

– appendBlobReferenceFromName:snapshotTime:

Initialize a local AZSCloudAppendBlob object

- (AZSCloudAppendBlob *)appendBlobReferenceFromName:(NSString *)blobName snapshotTime:(NSString *)snapshotTime

Parameters

blobName

The name of the block blob (part of the URL)
snapshotTime

The snapshot time for the blob. Nil means the root blob (not a snapshot).

Return Value

The new block blob object.

Discussion

Initialize a local AZSCloudAppendBlob object

This creates an AZSCloudAppendBlob object with the input name.

Warning: This method does not make a service call. If properties, metadata, etc have been set on the service for this blob, this will not be reflected in the local container object.

Declared In

AZSCloudBlobContainer.h

– existsWithCompletionHandler:

Makes a service call to detect whether or not the container already exists on the service.

- (void)existsWithCompletionHandler:(void ( ^ ) ( NSError *, BOOL ))completionHandler

Parameters

completionHandler

The block of code to execute when the exists call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
BOOL YES if the container exists on the service, NO otherwise.

Discussion

Makes a service call to detect whether or not the container already exists on the service.

Declared In

AZSCloudBlobContainer.h

– existsWithAccessCondition:requestOptions:operationContext:completionHandler:

Makes a service call to detect whether or not the container already exists on the service.

- (void)existsWithAccessCondition:(AZSAccessCondition *)accessCondition requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *, BOOL ))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the exists call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
BOOL YES if the container exists on the service, NO otherwise.

Discussion

Makes a service call to detect whether or not the container already exists on the service.

Declared In

AZSCloudBlobContainer.h

– createContainerIfNotExistsWithCompletionHandler:

Creates the container on the service. Will return success if the container already exists.

- (void)createContainerIfNotExistsWithCompletionHandler:(void ( ^ ) ( NSError *, BOOL ))completionHandler

Parameters

completionHandler

The block of code to execute when the create call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Creates the container on the service. Will return success if the container already exists.

Declared In

AZSCloudBlobContainer.h

– createContainerIfNotExistsWithAccessType:requestOptions:operationContext:completionHandler:

Creates the container on the service. Will return success if the container already exists.

- (void)createContainerIfNotExistsWithAccessType:(AZSContainerPublicAccessType)accessType requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *, BOOL ))completionHandler

Parameters

accessType

The access type that the container should have.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the create call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Creates the container on the service. Will return success if the container already exists.

Declared In

AZSCloudBlobContainer.h

– deleteContainerIfExistsWithCompletionHandler:

Deletes the container on the service. Will return success if the container does not exist.

- (void)deleteContainerIfExistsWithCompletionHandler:(void ( ^ ) ( NSError *, BOOL ))completionHandler

Parameters

completionHandler

The block of code to execute when the delete call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Deletes the container on the service. Will return success if the container does not exist.

Declared In

AZSCloudBlobContainer.h

– deleteContainerIfExistsWithAccessCondition:requestOptions:operationContext:completionHandler:

Deletes the container on the service. Will return success if the container does not exist.

- (void)deleteContainerIfExistsWithAccessCondition:(AZSAccessCondition *)accessCondition requestOptions:(AZSBlobRequestOptions *)requestOptions operationContext:(AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *, BOOL ))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the delete call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Deletes the container on the service. Will return success if the container does not exist.

Declared In

AZSCloudBlobContainer.h

– createSharedAccessSignatureWithParameters:error:

Creates a Shared Access Signature (SAS) token from the given parameters for this Container. Note that logging in this method uses the global logger configured statically on the AZSOperationContext as there is no operation being performed to provide a local operation context.

- (NSString *)createSharedAccessSignatureWithParameters:(AZSSharedAccessBlobParameters *)parameters error:(NSError **)error

Parameters

parameters

The shared access blob parameters from which to create the SAS token.
error

A pointer to a NSError*, to be set in the event of failure.

Return Value

The newly created SAS token.

Discussion

Creates a Shared Access Signature (SAS) token from the given parameters for this Container. Note that logging in this method uses the global logger configured statically on the AZSOperationContext as there is no operation being performed to provide a local operation context.

Declared In

AZSCloudBlobContainer.h

– directoryReferenceFromName:

Initialize a local AZSCloudBlobDirectory object

- (AZSCloudBlobDirectory *)directoryReferenceFromName:(NSString *)directoryName

Parameters

directoryName

The name of the directory

Return Value

The newly allocated directory object.

Discussion

Initialize a local AZSCloudBlobDirectory object

Declared In

AZSCloudBlobContainer.h

Other Methods

  name

The name of this container.

@property (copy) NSString *name

Discussion

The name of this container.

Declared In

AZSCloudBlobContainer.h

  client

The AZSCloudBlobClient representing the blob service that this container is in.

@property (strong) AZSCloudBlobClient *client

Discussion

The AZSCloudBlobClient representing the blob service that this container is in.

Declared In

AZSCloudBlobContainer.h

  storageUri

The StorageUri to this container.

@property (strong) AZSStorageUri *storageUri

Discussion

The StorageUri to this container.

Declared In

AZSCloudBlobContainer.h

  metadata

The metadata on this container.

@property (strong) NSMutableDictionary *metadata

Discussion

The metadata on this container.

Declared In

AZSCloudBlobContainer.h

  properties

The properties of this container.

@property (strong) AZSBlobContainerProperties *properties

Discussion

The properties of this container.

Declared In

AZSCloudBlobContainer.h