CloudQueue.GetSharedAccessSignature Method

Definition

Namespace:

Microsoft.Azure.Storage.Queue

Assembly:

Microsoft.Azure.Storage.Queue.dll

Package:

Microsoft.Azure.Storage.Queue v11.2.3

Overloads

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

GetSharedAccessSignature(SharedAccessQueuePolicy)

Returns a shared access signature for the queue.

public string GetSharedAccessSignature (Microsoft.Azure.Storage.Queue.SharedAccessQueuePolicy policy);

member this.GetSharedAccessSignature : Microsoft.Azure.Storage.Queue.SharedAccessQueuePolicy -> string

Public Function GetSharedAccessSignature (policy As SharedAccessQueuePolicy) As String

Parameters

policy

SharedAccessQueuePolicy

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

Returns

String

A shared access signature, as a URI query string.

Remarks

The query string returned includes the leading question mark.

GetSharedAccessSignature(SharedAccessQueuePolicy, String)

Returns a shared access signature for the queue.

public string GetSharedAccessSignature (Microsoft.Azure.Storage.Queue.SharedAccessQueuePolicy policy, string accessPolicyIdentifier);

member this.GetSharedAccessSignature : Microsoft.Azure.Storage.Queue.SharedAccessQueuePolicy * string -> string

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

Parameters

policy

SharedAccessQueuePolicy

A SharedAccessQueuePolicy 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.

Remarks

The query string returned includes the leading question mark.

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

Returns a shared access signature for the queue.

public string GetSharedAccessSignature (Microsoft.Azure.Storage.Queue.SharedAccessQueuePolicy policy, string accessPolicyIdentifier, Microsoft.Azure.Storage.SharedAccessProtocol? protocols, Microsoft.Azure.Storage.IPAddressOrRange ipAddressOrRange);

member this.GetSharedAccessSignature : Microsoft.Azure.Storage.Queue.SharedAccessQueuePolicy * string * Nullable<Microsoft.Azure.Storage.SharedAccessProtocol> * Microsoft.Azure.Storage.IPAddressOrRange -> string

Public Function GetSharedAccessSignature (policy As SharedAccessQueuePolicy, accessPolicyIdentifier As String, protocols As Nullable(Of SharedAccessProtocol), ipAddressOrRange As IPAddressOrRange) As String

Parameters

policy

SharedAccessQueuePolicy

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

accessPolicyIdentifier

String

A string identifying a stored access policy.

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.

Remarks

The query string returned includes the leading question mark.