Class SharedAccessSignatureToken

Namespace

Microsoft.ServiceBus

Assembly

Microsoft.ServiceBus.dll

Represents the shared access signature token.

public class SharedAccessSignatureToken : SimpleWebSecurityToken

Inheritance

object

SimpleWebSecurityToken

SharedAccessSignatureToken

Inherited Members

SimpleWebSecurityToken.Audience

SimpleWebSecurityToken.ExpiresOn

SimpleWebSecurityToken.Id

SimpleWebSecurityToken.SecurityKeys

SimpleWebSecurityToken.ValidFrom

SimpleWebSecurityToken.ValidTo

SimpleWebSecurityToken.Token

Constructors

SharedAccessSignatureToken(string)

Initializes a new instance of the SharedAccessSignatureToken class with specified token string.

public SharedAccessSignatureToken(string tokenString)

Parameters

tokenString string

The token string.

SharedAccessSignatureToken(string, DateTime)

Initializes a new instance of the SharedAccessSignatureToken class with specified token string and expiry.

public SharedAccessSignatureToken(string tokenString, DateTime expiry)

Parameters

tokenString string

The token string.

expiry DateTime

The token expiry.

SharedAccessSignatureToken(string, DateTime, string)

Initializes a new instance of the SharedAccessSignatureToken class with specified token string, expiry and audience.

public SharedAccessSignatureToken(string tokenString, DateTime expiry, string audience)

Parameters

tokenString string

The token string.

expiry DateTime

The token expiry.

audience string

The token audience.

SharedAccessSignatureToken(string, string)

Initializes a new instance of the SharedAccessSignatureToken class with specified identifier and token string.

public SharedAccessSignatureToken(string id, string tokenString)

Parameters

id string

The token identifier.

tokenString string

The token string.

Fields

MaxKeyLength

Specifies the maximum length of the key.

public const int MaxKeyLength = 256

Field Value

int

MaxKeyNameLength

Specifies the maximum length of the key name.

public const int MaxKeyNameLength = 256

Field Value

int

SasKeyValueSeparator

Specifies the key value separator for shared access signature token.

public const string SasKeyValueSeparator = "="

Field Value

string

SasPairSeparator

Specifies the pair separator for shared access signature token.

public const string SasPairSeparator = "&"

Field Value

string

SharedAccessSignature

Specifies the shared access signature.

public const string SharedAccessSignature = "SharedAccessSignature"

Field Value

string

Signature

Specifies the signature token.

public const string Signature = "sig"

Field Value

string

SignedExpiry

Specifies the signed expiry of the token.

public const string SignedExpiry = "se"

Field Value

string

SignedKeyName

Specifies the signed key name.

public const string SignedKeyName = "skn"

Field Value

string

SignedResource

Specifies the signed resource.

public const string SignedResource = "sr"

Field Value

string

SignedResourceFullFieldName

Specifies the full field name of the signed resource.

public const string SignedResourceFullFieldName = "SharedAccessSignature sr"

Field Value

string

Properties

AudienceFieldName

Gets the audience field name.

protected override string AudienceFieldName { get; }

Property Value

string

The audience field name.

ExpiresOnFieldName

Gets the value that expires on field name.

protected override string ExpiresOnFieldName { get; }

Property Value

string

The value that expires on field name.

KeyValueSeparator

Gets the key value separator.

protected override string KeyValueSeparator { get; }

Property Value

string

The key value separator.

PairSeparator

Gets the pair separator associated with the token.

protected override string PairSeparator { get; }

Property Value

string

The pair separator associated with the token.