AZSCloudStorageAccount Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | AZSCloudStorageAccount.h AZSCloudStorageAccount.m |
Overview
AZSCloudStorageAccount represents a given Storage Account.
Used primarily for creating AZSCloudClient objects.
+ accountFromConnectionString:error:
Parse a CloudStorageAccount from a connection string.
+ (AZSNullable AZSCloudStorageAccount *)accountFromConnectionString:(NSString *)connectionString error:(NSError **)errorParameters
connectionString |
The connection string to parse. |
|---|---|
error |
A pointer to a NSError, to be set in case of failure. |
Return Value
The newly created AZSCloudStorageAccount object, or nil in case of failure.
Discussion
Parse a CloudStorageAccount from a connection string.
Pass in a connection string containing credentials to connect to the Storage service. This method will parse out everything necessary and create the AZSCloudStorageAccount instance, as well as the AZSStorageCredentials instance.
Currently, this is the only supported format:
“DefaultEndpointsProtocol=https;AccountName=
Declared In
AZSCloudStorageAccount.h
– initWithCredentials:blobEndpoint:tableEndpoint:queueEndpoint:fileEndpoint:error:
Initialize a fresh AZSCloudStorageAccount object
- (AZSNullable instancetype)initWithCredentials:(AZSStorageCredentials *)storageCredentials blobEndpoint:(AZSNullable AZSStorageUri *)blobEndpoint tableEndpoint:(AZSNullable AZSStorageUri *)tableEndpoint queueEndpoint:(AZSNullable AZSStorageUri *)queueEndpoint fileEndpoint:(AZSNullable AZSStorageUri *)fileEndpoint error:(NSError **)errorParameters
storageCredentials |
The AZSStorageCredentials object containing connection information. |
|---|---|
blobEndpoint |
An explicit blob endpoint to use in place of the one the account generates automatically. |
tableEndpoint |
An explicit table endpoint to use in place of the one the account generates automatically. |
queueEndpoint |
An explicit queue endpoint to use in place of the one the account generates automatically. |
fileEndpoint |
An explicit file endpoint to use in place of the one the account generates automatically. |
error |
A pointer to a NSError, to be set in case of failure. |
Return Value
The freshly allocated AZSCloudStorageAccount, or nil in case of failure.
Discussion
Initialize a fresh AZSCloudStorageAccount object
Declared In
AZSCloudStorageAccount.h
– initWithCredentials:useHttps:error:
Initialize a fresh AZSCloudStorageAccount object
- (AZSNullable instancetype)initWithCredentials:(AZSStorageCredentials *)storageCredentials useHttps:(BOOL)useHttps error:(NSError **)errorParameters
storageCredentials |
The AZSStorageCredentials object containing connection information. |
|---|---|
useHttps |
Whether requests should use HTTPS or HTTP. |
error |
A pointer to a NSError, to be set in case of failure. |
Return Value
The freshly allocated AZSCloudStorageAccount, or nil in case of failure.
Discussion
Initialize a fresh AZSCloudStorageAccount object
Declared In
AZSCloudStorageAccount.h
– initWithCredentials:useHttps:endpointSuffix:error:
Initialize a fresh AZSCloudStorageAccount object
- (AZSNullable instancetype)initWithCredentials:(AZSStorageCredentials *)storageCredentials useHttps:(BOOL)useHttps endpointSuffix:(NSString *)endpointSuffix error:(NSError **)errorParameters
storageCredentials |
The AZSStorageCredentials object containing connection information. |
|---|---|
useHttps |
Whether requests should use HTTPS or HTTP. |
endpointSuffix |
An explicit endpoint to use in place of the one the account generates automatically. |
error |
A pointer to a NSError, to be set in case of failure. |
Return Value
The freshly allocated AZSCloudStorageAccount, or nil in case of failure.
Discussion
Initialize a fresh AZSCloudStorageAccount object
Declared In
AZSCloudStorageAccount.h
– getBlobClient
Create an AZSCloudBlobClient object
- (AZSCloudBlobClient *)getBlobClientReturn Value
The freshly created AZSCloudBlobClient.
Discussion
Create an AZSCloudBlobClient object
Declared In
AZSCloudStorageAccount.h
– createSharedAccessSignatureWithParameters:error:
Creates a Shared Access Signature (SAS) token from the given parameters for this Account. 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.
- (AZSNullable NSString *)createSharedAccessSignatureWithParameters:(AZSSharedAccessAccountParameters *)parameters error:(NSError **)errorParameters
parameters |
The shared access account 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 Account. 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
AZSCloudStorageAccount.h