CloudBlob.GetUserDelegationSharedAccessSignature Method

Definition

Namespace:

Microsoft.Azure.Storage.Blob

Assembly:

Microsoft.Azure.Storage.Blob.dll

Package:

Microsoft.Azure.Storage.Blob v11.2.3

Returns an user-delegation-based shared access signature for the blob, with credentials solely based on the UserDelegationKey provided.

public string GetUserDelegationSharedAccessSignature (Microsoft.Azure.Storage.UserDelegationKey delegationKey, Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy policy, Microsoft.Azure.Storage.Blob.SharedAccessBlobHeaders headers = default, Microsoft.Azure.Storage.SharedAccessProtocol? protocols = default, Microsoft.Azure.Storage.IPAddressOrRange ipAddressOrRange = default);

member this.GetUserDelegationSharedAccessSignature : Microsoft.Azure.Storage.UserDelegationKey * Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy * Microsoft.Azure.Storage.Blob.SharedAccessBlobHeaders * Nullable<Microsoft.Azure.Storage.SharedAccessProtocol> * Microsoft.Azure.Storage.IPAddressOrRange -> string

Public Function GetUserDelegationSharedAccessSignature (delegationKey As UserDelegationKey, policy As SharedAccessBlobPolicy, Optional headers As SharedAccessBlobHeaders = Nothing, Optional protocols As Nullable(Of SharedAccessProtocol) = Nothing, Optional ipAddressOrRange As IPAddressOrRange = Nothing) As String

Parameters

delegationKey

UserDelegationKey

UserDelegationKey for signing this SAS token.

policy

SharedAccessBlobPolicy

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

headers

SharedAccessBlobHeaders

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

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