CloudBlob.GetSharedAccessSignature Method (SharedAccessBlobPolicy, SharedAccessBlobHeaders, String, Nullable(SharedAccessProtocol), IPAddressOrRange) (Microsoft.WindowsAzure.Storage.Blob)

Returns a shared access signature for the blob.

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

Syntax

C#

Copy Code

 

public string GetSharedAccessSignature(
	SharedAccessBlobPolicy policy,
	SharedAccessBlobHeaders headers,
	string groupPolicyIdentifier,
	Nullable<SharedAccessProtocol> protocols,
	IPAddressOrRange ipAddressOrRange
)

C++

Copy Code

 

public:
virtual String^ GetSharedAccessSignature(
	SharedAccessBlobPolicy^ policy,
	SharedAccessBlobHeaders^ headers,
	String^ groupPolicyIdentifier,
	Nullable<SharedAccessProtocol> protocols,
	IPAddressOrRange^ ipAddressOrRange
) sealed

F#

Copy Code

 

abstract GetSharedAccessSignature : 
        policy:SharedAccessBlobPolicy *
        headers:SharedAccessBlobHeaders *
        groupPolicyIdentifier:string *
        protocols:Nullable<SharedAccessProtocol> *
        ipAddressOrRange:IPAddressOrRange -> string
override GetSharedAccessSignature : 
        policy:SharedAccessBlobPolicy *
        headers:SharedAccessBlobHeaders *
        groupPolicyIdentifier:string *
        protocols:Nullable<SharedAccessProtocol> *
        ipAddressOrRange:IPAddressOrRange -> string

VB

Copy Code

 

Public Function GetSharedAccessSignature (
	policy As SharedAccessBlobPolicy,
	headers As SharedAccessBlobHeaders,
	groupPolicyIdentifier As String,
	protocols As Nullable(Of SharedAccessProtocol),
	ipAddressOrRange As IPAddressOrRange
) As String

Parameters

policy

Type: Microsoft.WindowsAzure.Storage.Blob.SharedAccessBlobPolicyMicrosoft.WindowsAzure.Storage.Blob::SharedAccessBlobPolicy^Microsoft.WindowsAzure.Storage.Blob.SharedAccessBlobPolicyMicrosoft.WindowsAzure.Storage.Blob.SharedAccessBlobPolicy

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

headers

Type: Microsoft.WindowsAzure.Storage.Blob.SharedAccessBlobHeadersMicrosoft.WindowsAzure.Storage.Blob::SharedAccessBlobHeaders^Microsoft.WindowsAzure.Storage.Blob.SharedAccessBlobHeadersMicrosoft.WindowsAzure.Storage.Blob.SharedAccessBlobHeaders

A SharedAccessBlobHeaders object specifying optional header values to set for a blob accessed with this SAS.

groupPolicyIdentifier

Type: System.StringSystem::String^System.StringSystem.String

A string identifying a stored access policy.

protocols

Type: System.Nullable<SharedAccessProtocol>System::Nullable<SharedAccessProtocol>System.Nullable<SharedAccessProtocol>System.Nullable(Of SharedAccessProtocol)

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

ipAddressOrRange

Type: Microsoft.WindowsAzure.Storage.IPAddressOrRangeMicrosoft.WindowsAzure.Storage::IPAddressOrRange^Microsoft.WindowsAzure.Storage.IPAddressOrRangeMicrosoft.WindowsAzure.Storage.IPAddressOrRange

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

Return Value

Type: System.StringSystem::String^System.StringSystem.String

A shared access signature, as a URI query string.

See Also

GetSharedAccessSignature Overload
CloudBlob Class
Microsoft.WindowsAzure.Storage.Blob Namespace

Return to top