ShareFileClient.GenerateSasUri Method

Definition

Namespace:

Azure.Storage.Files.Shares

Assembly:

Azure.Storage.Files.Shares.dll

Package:

Azure.Storage.Files.Shares v12.20.1

Overloads

GenerateSasUri(ShareSasBuilder)	The GenerateSasUri(ShareSasBuilder) returns a Uri that generates a Share File Service Shared Access Signature (SAS) Uri based on the Client properties and and builder. The SAS is signed by the shared key credential of the client. To check if the client is able to sign a Service Sas see CanGenerateSasUri. For more information, see Constructing a Service SAS.
GenerateSasUri(ShareFileSasPermissions, DateTimeOffset)	The GenerateSasUri(ShareFileSasPermissions, DateTimeOffset) returns a Uri that generates a Share File Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. The SAS is signed by the shared key credential of the client. To check if the client is able to sign a Service Sas see CanGenerateSasUri. For more information, see Constructing a service SAS.

GenerateSasUri(ShareSasBuilder)

Source:

ShareFileClient.cs

The GenerateSasUri(ShareSasBuilder) returns a Uri that generates a Share File Service Shared Access Signature (SAS) Uri based on the Client properties and and builder. The SAS is signed by the shared key credential of the client.

To check if the client is able to sign a Service Sas see CanGenerateSasUri.

For more information, see Constructing a Service SAS.

public virtual Uri GenerateSasUri (Azure.Storage.Sas.ShareSasBuilder builder);

abstract member GenerateSasUri : Azure.Storage.Sas.ShareSasBuilder -> Uri
override this.GenerateSasUri : Azure.Storage.Sas.ShareSasBuilder -> Uri

Public Overridable Function GenerateSasUri (builder As ShareSasBuilder) As Uri

Parameters

builder

ShareSasBuilder

Used to generate a Shared Access Signature (SAS)

Returns

Uri

A ShareSasBuilder on successfully deleting.

Remarks

A RequestFailedException will be thrown if a failure occurs.

GenerateSasUri(ShareFileSasPermissions, DateTimeOffset)

Source:

ShareFileClient.cs

The GenerateSasUri(ShareFileSasPermissions, DateTimeOffset) returns a Uri that generates a Share File Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. The SAS is signed by the shared key credential of the client.

To check if the client is able to sign a Service Sas see CanGenerateSasUri.

For more information, see Constructing a service SAS.

public virtual Uri GenerateSasUri (Azure.Storage.Sas.ShareFileSasPermissions permissions, DateTimeOffset expiresOn);

abstract member GenerateSasUri : Azure.Storage.Sas.ShareFileSasPermissions * DateTimeOffset -> Uri
override this.GenerateSasUri : Azure.Storage.Sas.ShareFileSasPermissions * DateTimeOffset -> Uri

Public Overridable Function GenerateSasUri (permissions As ShareFileSasPermissions, expiresOn As DateTimeOffset) As Uri

Parameters

permissions

ShareFileSasPermissions

Required. Specifies the list of permissions to be associated with the SAS. See ShareFileSasPermissions.

expiresOn

DateTimeOffset

Required. Specifies the time at which the SAS becomes invalid. This field must be omitted if it has been specified in an associated stored access policy.

Returns

Uri

A Uri containing the SAS Uri.

Remarks

A Exception will be thrown if a failure occurs.