CloudTable.GetSharedAccessSignature Method

Definition

Namespace:

Microsoft.Azure.Cosmos.Table

Assembly:

Microsoft.Azure.Cosmos.Table.dll

Package:

Microsoft.Azure.Cosmos.Table v1.0.8

Overloads

GetSharedAccessSignature(SharedAccessTablePolicy)	Returns a shared access signature for the table.
GetSharedAccessSignature(SharedAccessTablePolicy, String)	Returns a shared access signature for the table.
GetSharedAccessSignature(SharedAccessTablePolicy, String, String, String, String, String)	Returns a shared access signature for the table.
GetSharedAccessSignature(SharedAccessTablePolicy, String, String, String, String, String, Nullable<SharedAccessProtocol>, IPAddressOrRange)	Returns a shared access signature for the table.

GetSharedAccessSignature(SharedAccessTablePolicy)

Returns a shared access signature for the table.

public string GetSharedAccessSignature (Microsoft.Azure.Cosmos.Table.SharedAccessTablePolicy policy);

member this.GetSharedAccessSignature : Microsoft.Azure.Cosmos.Table.SharedAccessTablePolicy -> string

Public Function GetSharedAccessSignature (policy As SharedAccessTablePolicy) As String

Parameters

policy

SharedAccessTablePolicy

A SharedAccessTablePolicy object specifying the access policy for the shared access signature.

Returns

String

A shared access signature, as a URI query string.

Exceptions

InvalidOperationException

Thrown if the current credentials don't support creating a shared access signature.

Remarks

The query string returned includes the leading question mark.

GetSharedAccessSignature(SharedAccessTablePolicy, String)

Returns a shared access signature for the table.

public string GetSharedAccessSignature (Microsoft.Azure.Cosmos.Table.SharedAccessTablePolicy policy, string accessPolicyIdentifier);

member this.GetSharedAccessSignature : Microsoft.Azure.Cosmos.Table.SharedAccessTablePolicy * string -> string

Public Function GetSharedAccessSignature (policy As SharedAccessTablePolicy, accessPolicyIdentifier As String) As String

Parameters

policy

SharedAccessTablePolicy

A SharedAccessTablePolicy object specifying the access policy for the shared access signature.

accessPolicyIdentifier

String

A string identifying a stored access policy.

Returns

String

A shared access signature, as a URI query string.

Exceptions

InvalidOperationException

Thrown if the current credentials don't support creating a shared access signature.

Remarks

The query string returned includes the leading question mark.

GetSharedAccessSignature(SharedAccessTablePolicy, String, String, String, String, String)

Returns a shared access signature for the table.

public string GetSharedAccessSignature (Microsoft.Azure.Cosmos.Table.SharedAccessTablePolicy policy, string accessPolicyIdentifier, string startPartitionKey, string startRowKey, string endPartitionKey, string endRowKey);

member this.GetSharedAccessSignature : Microsoft.Azure.Cosmos.Table.SharedAccessTablePolicy * string * string * string * string * string -> string

Public Function GetSharedAccessSignature (policy As SharedAccessTablePolicy, accessPolicyIdentifier As String, startPartitionKey As String, startRowKey As String, endPartitionKey As String, endRowKey As String) As String

Parameters

policy

SharedAccessTablePolicy

A SharedAccessTablePolicy object specifying the access policy for the shared access signature.

accessPolicyIdentifier

String

A string identifying a stored access policy.

startPartitionKey

String

A string specifying the start partition key, or null.

startRowKey

String

A string specifying the start row key, or null.

endPartitionKey

String

A string specifying the end partition key, or null.

endRowKey

String

A string specifying the end row key, or null.

Returns

String

A shared access signature, as a URI query string.

Exceptions

InvalidOperationException

Thrown if the current credentials don't support creating a shared access signature.

Remarks

The query string returned includes the leading question mark.

GetSharedAccessSignature(SharedAccessTablePolicy, String, String, String, String, String, Nullable<SharedAccessProtocol>, IPAddressOrRange)

Returns a shared access signature for the table.

public string GetSharedAccessSignature (Microsoft.Azure.Cosmos.Table.SharedAccessTablePolicy policy, string accessPolicyIdentifier, string startPartitionKey, string startRowKey, string endPartitionKey, string endRowKey, Microsoft.Azure.Cosmos.Table.SharedAccessProtocol? protocols, Microsoft.Azure.Cosmos.Table.IPAddressOrRange ipAddressOrRange);

member this.GetSharedAccessSignature : Microsoft.Azure.Cosmos.Table.SharedAccessTablePolicy * string * string * string * string * string * Nullable<Microsoft.Azure.Cosmos.Table.SharedAccessProtocol> * Microsoft.Azure.Cosmos.Table.IPAddressOrRange -> string

Public Function GetSharedAccessSignature (policy As SharedAccessTablePolicy, accessPolicyIdentifier As String, startPartitionKey As String, startRowKey As String, endPartitionKey As String, endRowKey As String, protocols As Nullable(Of SharedAccessProtocol), ipAddressOrRange As IPAddressOrRange) As String

Parameters

policy

SharedAccessTablePolicy

A SharedAccessTablePolicy object specifying the access policy for the shared access signature.

accessPolicyIdentifier

String

A string identifying a stored access policy.

startPartitionKey

String

A string specifying the start partition key, or null.

startRowKey

String

A string specifying the start row key, or null.

endPartitionKey

String

A string specifying the end partition key, or null.

endRowKey

String

A string specifying the end row key, or null.

protocols

Nullable<SharedAccessProtocol>

The allowed protocols (https only, or http and https). Null if you don't want to restrict protocol.

ipAddressOrRange

IPAddressOrRange

The allowed IP address or IP address range. Null if you don't want to restrict based on IP address.

Returns

String

A shared access signature, as a URI query string.

Exceptions

InvalidOperationException

Thrown if the current credentials don't support creating a shared access signature.

Remarks

The query string returned includes the leading question mark.