Share via


CloudFile.GetSharedAccessSignature Method

Definition

Overloads

GetSharedAccessSignature(SharedAccessFilePolicy, SharedAccessFileHeaders, String, Nullable<SharedAccessProtocol>, IPAddressOrRange)

Returns a shared access signature for the file.

GetSharedAccessSignature(SharedAccessFilePolicy, SharedAccessFileHeaders, String)

Returns a shared access signature for the file.

GetSharedAccessSignature(SharedAccessFilePolicy)

Returns a shared access signature for the file.

GetSharedAccessSignature(SharedAccessFilePolicy, SharedAccessFileHeaders)

Returns a shared access signature for the file.

GetSharedAccessSignature(SharedAccessFilePolicy, String)

Returns a shared access signature for the file.

GetSharedAccessSignature(SharedAccessFilePolicy, SharedAccessFileHeaders, String, Nullable<SharedAccessProtocol>, IPAddressOrRange)

Returns a shared access signature for the file.

public string GetSharedAccessSignature (Microsoft.Azure.Storage.File.SharedAccessFilePolicy policy, Microsoft.Azure.Storage.File.SharedAccessFileHeaders headers, string groupPolicyIdentifier, Microsoft.Azure.Storage.SharedAccessProtocol? protocols, Microsoft.Azure.Storage.IPAddressOrRange ipAddressOrRange);
member this.GetSharedAccessSignature : Microsoft.Azure.Storage.File.SharedAccessFilePolicy * Microsoft.Azure.Storage.File.SharedAccessFileHeaders * string * Nullable<Microsoft.Azure.Storage.SharedAccessProtocol> * Microsoft.Azure.Storage.IPAddressOrRange -> string
Public Function GetSharedAccessSignature (policy As SharedAccessFilePolicy, headers As SharedAccessFileHeaders, groupPolicyIdentifier As String, protocols As Nullable(Of SharedAccessProtocol), ipAddressOrRange As IPAddressOrRange) As String

Parameters

policy
SharedAccessFilePolicy

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

headers
SharedAccessFileHeaders

A SharedAccessFileHeaders object specifying optional header values to set for a file accessed with this SAS.

groupPolicyIdentifier
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

A shared access signature, as a URI query string.

Applies to

GetSharedAccessSignature(SharedAccessFilePolicy, SharedAccessFileHeaders, String)

Returns a shared access signature for the file.

public string GetSharedAccessSignature (Microsoft.Azure.Storage.File.SharedAccessFilePolicy policy, Microsoft.Azure.Storage.File.SharedAccessFileHeaders headers, string groupPolicyIdentifier);
member this.GetSharedAccessSignature : Microsoft.Azure.Storage.File.SharedAccessFilePolicy * Microsoft.Azure.Storage.File.SharedAccessFileHeaders * string -> string
Public Function GetSharedAccessSignature (policy As SharedAccessFilePolicy, headers As SharedAccessFileHeaders, groupPolicyIdentifier As String) As String

Parameters

policy
SharedAccessFilePolicy

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

headers
SharedAccessFileHeaders

A SharedAccessFileHeaders object specifying optional header values to set for a file accessed with this SAS.

groupPolicyIdentifier
String

A string identifying a stored access policy.

Returns

A shared access signature, as a URI query string.

Applies to

GetSharedAccessSignature(SharedAccessFilePolicy)

Returns a shared access signature for the file.

public string GetSharedAccessSignature (Microsoft.Azure.Storage.File.SharedAccessFilePolicy policy);
member this.GetSharedAccessSignature : Microsoft.Azure.Storage.File.SharedAccessFilePolicy -> string
Public Function GetSharedAccessSignature (policy As SharedAccessFilePolicy) As String

Parameters

policy
SharedAccessFilePolicy

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

Returns

A shared access signature, as a URI query string.

Remarks

The query string returned includes the leading question mark.

Applies to

GetSharedAccessSignature(SharedAccessFilePolicy, SharedAccessFileHeaders)

Returns a shared access signature for the file.

public string GetSharedAccessSignature (Microsoft.Azure.Storage.File.SharedAccessFilePolicy policy, Microsoft.Azure.Storage.File.SharedAccessFileHeaders headers);
member this.GetSharedAccessSignature : Microsoft.Azure.Storage.File.SharedAccessFilePolicy * Microsoft.Azure.Storage.File.SharedAccessFileHeaders -> string
Public Function GetSharedAccessSignature (policy As SharedAccessFilePolicy, headers As SharedAccessFileHeaders) As String

Parameters

policy
SharedAccessFilePolicy

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

headers
SharedAccessFileHeaders

A SharedAccessFileHeaders object specifying optional header values to set for a file accessed with this SAS.

Returns

A shared access signature, as a URI query string.

Applies to

GetSharedAccessSignature(SharedAccessFilePolicy, String)

Returns a shared access signature for the file.

public string GetSharedAccessSignature (Microsoft.Azure.Storage.File.SharedAccessFilePolicy policy, string groupPolicyIdentifier);
member this.GetSharedAccessSignature : Microsoft.Azure.Storage.File.SharedAccessFilePolicy * string -> string
Public Function GetSharedAccessSignature (policy As SharedAccessFilePolicy, groupPolicyIdentifier As String) As String

Parameters

policy
SharedAccessFilePolicy

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

groupPolicyIdentifier
String

A string identifying a stored access policy.

Returns

A shared access signature, as a URI query string.

Remarks

The query string returned includes the leading question mark.

Applies to