DataLakeFileSystemClient.GenerateSasUri Method

  • Reference

Definition

Namespace:
Azure.Storage.Files.DataLake
Assembly:
Azure.Storage.Files.DataLake.dll
Package:
Azure.Storage.Files.DataLake v12.20.1
Package:
Azure.Storage.Files.DataLake v12.21.0-beta.2

Overloads

GenerateSasUri(DataLakeSasBuilder)

The GenerateSasUri(DataLakeSasBuilder) returns a Uri that generates a DataLake FileSystem Service Shared Access Signature (SAS) Uri based on the Client properties and builder 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(DataLakeFileSystemSasPermissions, DateTimeOffset)

The GenerateSasUri(DataLakeFileSystemSasPermissions, DateTimeOffset) returns a Uri that generates a DataLake FileSystem Service Shared Access Signature (SAS) Uri based on the BlobContainerClient 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(DataLakeSasBuilder)

Source:
DataLakeFileSystemClient.cs
Source:
DataLakeFileSystemClient.cs

The GenerateSasUri(DataLakeSasBuilder) returns a Uri that generates a DataLake FileSystem Service Shared Access Signature (SAS) Uri based on the Client properties and builder 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.DataLakeSasBuilder builder);
abstract member GenerateSasUri : Azure.Storage.Sas.DataLakeSasBuilder -> Uri
override this.GenerateSasUri : Azure.Storage.Sas.DataLakeSasBuilder -> Uri
Public Overridable Function GenerateSasUri (builder As DataLakeSasBuilder) As Uri

Parameters

builder
DataLakeSasBuilder

Used to generate a Shared Access Signature (SAS).

Returns

Uri

A DataLakeSasBuilder on successfully deleting.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

GenerateSasUri(DataLakeFileSystemSasPermissions, DateTimeOffset)

Source:
DataLakeFileSystemClient.cs
Source:
DataLakeFileSystemClient.cs

The GenerateSasUri(DataLakeFileSystemSasPermissions, DateTimeOffset) returns a Uri that generates a DataLake FileSystem Service Shared Access Signature (SAS) Uri based on the BlobContainerClient 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.DataLakeFileSystemSasPermissions permissions, DateTimeOffset expiresOn);
abstract member GenerateSasUri : Azure.Storage.Sas.DataLakeFileSystemSasPermissions * DateTimeOffset -> Uri
override this.GenerateSasUri : Azure.Storage.Sas.DataLakeFileSystemSasPermissions * DateTimeOffset -> Uri
Public Overridable Function GenerateSasUri (permissions As DataLakeFileSystemSasPermissions, expiresOn As DateTimeOffset) As Uri

Parameters

permissions
DataLakeFileSystemSasPermissions

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

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.

Applies to