CloudBlob.GetSharedAccessSignature Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
GetSharedAccessSignature(SharedAccessBlobPolicy) |
Returns a shared access signature for the blob. |
GetSharedAccessSignature(SharedAccessBlobPolicy, SharedAccessBlobHeaders) |
Returns a shared access signature for the blob. |
GetSharedAccessSignature(SharedAccessBlobPolicy, String) |
Returns a shared access signature for the blob. |
GetSharedAccessSignature(SharedAccessBlobPolicy, SharedAccessBlobHeaders, String) |
Returns a shared access signature for the blob. |
GetSharedAccessSignature(SharedAccessBlobPolicy, SharedAccessBlobHeaders, String, Nullable<SharedAccessProtocol>, IPAddressOrRange) |
Returns a shared access signature for the blob. |
GetSharedAccessSignature(SharedAccessBlobPolicy)
Returns a shared access signature for the blob.
public string GetSharedAccessSignature (Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy policy);
abstract member GetSharedAccessSignature : Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy -> string
override this.GetSharedAccessSignature : Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy -> string
Public Function GetSharedAccessSignature (policy As SharedAccessBlobPolicy) As String
Parameters
- policy
- SharedAccessBlobPolicy
A SharedAccessBlobPolicy 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(SharedAccessBlobPolicy, SharedAccessBlobHeaders)
Returns a shared access signature for the blob.
public string GetSharedAccessSignature (Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy policy, Microsoft.Azure.Storage.Blob.SharedAccessBlobHeaders headers);
abstract member GetSharedAccessSignature : Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy * Microsoft.Azure.Storage.Blob.SharedAccessBlobHeaders -> string
override this.GetSharedAccessSignature : Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy * Microsoft.Azure.Storage.Blob.SharedAccessBlobHeaders -> string
Public Function GetSharedAccessSignature (policy As SharedAccessBlobPolicy, headers As SharedAccessBlobHeaders) As String
Parameters
- 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.
Returns
A shared access signature, as a URI query string.
Applies to
GetSharedAccessSignature(SharedAccessBlobPolicy, String)
Returns a shared access signature for the blob.
public string GetSharedAccessSignature (Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy policy, string groupPolicyIdentifier);
abstract member GetSharedAccessSignature : Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy * string -> string
override this.GetSharedAccessSignature : Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy * string -> string
Public Function GetSharedAccessSignature (policy As SharedAccessBlobPolicy, groupPolicyIdentifier As String) As String
Parameters
- policy
- SharedAccessBlobPolicy
A SharedAccessBlobPolicy 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
GetSharedAccessSignature(SharedAccessBlobPolicy, SharedAccessBlobHeaders, String)
Returns a shared access signature for the blob.
public string GetSharedAccessSignature (Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy policy, Microsoft.Azure.Storage.Blob.SharedAccessBlobHeaders headers, string groupPolicyIdentifier);
abstract member GetSharedAccessSignature : Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy * Microsoft.Azure.Storage.Blob.SharedAccessBlobHeaders * string -> string
override this.GetSharedAccessSignature : Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy * Microsoft.Azure.Storage.Blob.SharedAccessBlobHeaders * string -> string
Public Function GetSharedAccessSignature (policy As SharedAccessBlobPolicy, headers As SharedAccessBlobHeaders, groupPolicyIdentifier As String) As String
Parameters
- 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.
- groupPolicyIdentifier
- String
A string identifying a stored access policy.
Returns
A shared access signature, as a URI query string.
Applies to
GetSharedAccessSignature(SharedAccessBlobPolicy, SharedAccessBlobHeaders, String, Nullable<SharedAccessProtocol>, IPAddressOrRange)
Returns a shared access signature for the blob.
public string GetSharedAccessSignature (Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy policy, Microsoft.Azure.Storage.Blob.SharedAccessBlobHeaders headers, string groupPolicyIdentifier, Microsoft.Azure.Storage.SharedAccessProtocol? protocols, Microsoft.Azure.Storage.IPAddressOrRange ipAddressOrRange);
abstract member GetSharedAccessSignature : Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy * Microsoft.Azure.Storage.Blob.SharedAccessBlobHeaders * string * Nullable<Microsoft.Azure.Storage.SharedAccessProtocol> * Microsoft.Azure.Storage.IPAddressOrRange -> string
override this.GetSharedAccessSignature : Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy * Microsoft.Azure.Storage.Blob.SharedAccessBlobHeaders * string * Nullable<Microsoft.Azure.Storage.SharedAccessProtocol> * Microsoft.Azure.Storage.IPAddressOrRange -> string
Public Function GetSharedAccessSignature (policy As SharedAccessBlobPolicy, headers As SharedAccessBlobHeaders, groupPolicyIdentifier As String, protocols As Nullable(Of SharedAccessProtocol), ipAddressOrRange As IPAddressOrRange) As String
Parameters
- 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.
- 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.