StorageCredentials Class (Microsoft.WindowsAzure.Storage.Auth)

Represents a set of credentials used to authenticate access to a Windows Azure storage account.

Namespace:   Microsoft.WindowsAzure.Storage.Auth
Assembly:  Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)

Inheritance Hierarchy

System.::..Object
  Microsoft.WindowsAzure.Storage.Auth.::..StorageCredentials

Syntax

C#

Copy Code

 

public sealed class StorageCredentials

C++

Copy Code

 

public ref class StorageCredentials sealed 

F#

Copy Code

 

[<Sealed>]
type StorageCredentials = class end

VB

Copy Code

 

Public NotInheritable Class StorageCredentials

Constructors

	Name	Description
	StorageCredentials()()()()	Initializes a new instance of the StorageCredentials class.
	StorageCredentials(String)(String^)(String)(String)	Initializes a new instance of the StorageCredentials class with the specified shared access signature token.
	StorageCredentials(String, Byte[])(String^, array<Byte>^)(String, Byte[])(String, Byte())	Initializes a new instance of the StorageCredentials class with the specified account name and key value.
	StorageCredentials(String, Byte[], String)(String^, array<Byte>^, String^)(String, Byte[], String)(String, Byte(), String)	Initializes a new instance of the StorageCredentials class with the specified account name, key value, and key name.
	StorageCredentials(String, String)(String^, String^)(String, String)(String, String)	Initializes a new instance of the StorageCredentials class with the specified account name and key value.
	StorageCredentials(String, String, String)(String^, String^, String^)(String, String, String)(String, String, String)	Initializes a new instance of the StorageCredentials class with the specified account name, key value, and key name.

Properties

	Name	Description
	AccountNameAccountNameAccountNameAccountName	Gets the associated account name for the credentials.
	IsAnonymousIsAnonymousIsAnonymousIsAnonymous	Gets a value indicating whether the credentials are for anonymous access.
	IsSASIsSASIsSASIsSAS	Gets a value indicating whether the credentials are a shared access signature token.
	IsSharedKeyIsSharedKeyIsSharedKeyIsSharedKey	Gets a value indicating whether the credentials are a shared key.
	KeyNameKeyNameKeyNameKeyName	Gets the associated key name for the credentials.
	SASSignatureSASSignatureSASSignatureSASSignature	Gets the value of the shared access signature token's Copy Code   sig parameter.
	SASTokenSASTokenSASTokenSASToken	Gets the associated shared access signature token for the credentials.

Methods

	Name	Description
	Equals(Object)(Object^)(Object)(Object)	(Inherited from Object.)
	Equals(StorageCredentials)(StorageCredentials^)(StorageCredentials)(StorageCredentials)	Determines whether an other StorageCredentials object is equal to this one by comparing their SAS tokens, account names, key names, and key values.
	ExportBase64EncodedKey()()()()	Exports the value of the account access key to a Base64-encoded string.
	ExportKey()()()()	Returns the account key for the credentials.
	GetHashCode()()()()	(Inherited from Object.)
	GetType()()()()	(Inherited from Object.)
	ToString()()()()	(Inherited from Object.)
	TransformUri(StorageUri)(StorageUri^)(StorageUri)(StorageUri)	Transforms a resource URI into a shared access signature URI, by appending a shared access token.
	TransformUri(Uri)(Uri^)(Uri)(Uri)	Transforms a resource URI into a shared access signature URI, by appending a shared access token.
	UpdateKey(Byte[])(array<Byte>^)(Byte[])(Byte())	Updates the key value for the credentials.
	UpdateKey(Byte[], String)(array<Byte>^, String^)(Byte[], String)(Byte(), String)	Updates the key value and key name for the credentials.
	UpdateKey(String)(String^)(String)(String)	Updates the key value for the credentials.
	UpdateKey(String, String)(String^, String^)(String, String)(String, String)	Updates the key value and key name for the credentials.
	UpdateSASToken(String)(String^)(String)(String)	Updates the shared access signature (SAS) token value for storage credentials created with a shared access signature.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.WindowsAzure.Storage.Auth Namespace

Return to top