DataLakeFileSystemClient.GenerateUserDelegationSasUri Method

Definition

Namespace:

Azure.Storage.Files.DataLake

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.21.0

Overloads

GenerateUserDelegationSasUri(DataLakeSasBuilder, UserDelegationKey)	The GenerateUserDelegationSasUri(DataLakeSasBuilder, UserDelegationKey) 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 user delegation key passed in. For more information, see Creating an user delegation SAS.
GenerateUserDelegationSasUri(DataLakeFileSystemSasPermissions, DateTimeOffset, UserDelegationKey)	The GenerateUserDelegationSasUri(DataLakeFileSystemSasPermissions, DateTimeOffset, UserDelegationKey) returns a Uri that generates a DataLake FileSystem Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. The SAS is signed by the user delegation key passed in. For more information, see Creating an user delegation SAS.

GenerateUserDelegationSasUri(DataLakeSasBuilder, UserDelegationKey)

Source:

DataLakeFileSystemClient.cs

The GenerateUserDelegationSasUri(DataLakeSasBuilder, UserDelegationKey) 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 user delegation key passed in.

For more information, see Creating an user delegation SAS.

public virtual Uri GenerateUserDelegationSasUri (Azure.Storage.Sas.DataLakeSasBuilder builder, Azure.Storage.Files.DataLake.Models.UserDelegationKey userDelegationKey);

abstract member GenerateUserDelegationSasUri : Azure.Storage.Sas.DataLakeSasBuilder * Azure.Storage.Files.DataLake.Models.UserDelegationKey -> Uri
override this.GenerateUserDelegationSasUri : Azure.Storage.Sas.DataLakeSasBuilder * Azure.Storage.Files.DataLake.Models.UserDelegationKey -> Uri

Public Overridable Function GenerateUserDelegationSasUri (builder As DataLakeSasBuilder, userDelegationKey As UserDelegationKey) As Uri

Parameters

builder

DataLakeSasBuilder

Required. Used to generate a Shared Access Signature (SAS).

userDelegationKey

UserDelegationKey

Required. A UserDelegationKey returned from GetUserDelegationKeyAsync(Nullable<DateTimeOffset>, DateTimeOffset, CancellationToken).

Returns

Uri

A DataLakeSasBuilder on successfully deleting.

Remarks

A RequestFailedException will be thrown if a failure occurs.

GenerateUserDelegationSasUri(DataLakeFileSystemSasPermissions, DateTimeOffset, UserDelegationKey)

Source:

DataLakeFileSystemClient.cs

The GenerateUserDelegationSasUri(DataLakeFileSystemSasPermissions, DateTimeOffset, UserDelegationKey) returns a Uri that generates a DataLake FileSystem Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. The SAS is signed by the user delegation key passed in.

For more information, see Creating an user delegation SAS.

public virtual Uri GenerateUserDelegationSasUri (Azure.Storage.Sas.DataLakeFileSystemSasPermissions permissions, DateTimeOffset expiresOn, Azure.Storage.Files.DataLake.Models.UserDelegationKey userDelegationKey);

abstract member GenerateUserDelegationSasUri : Azure.Storage.Sas.DataLakeFileSystemSasPermissions * DateTimeOffset * Azure.Storage.Files.DataLake.Models.UserDelegationKey -> Uri
override this.GenerateUserDelegationSasUri : Azure.Storage.Sas.DataLakeFileSystemSasPermissions * DateTimeOffset * Azure.Storage.Files.DataLake.Models.UserDelegationKey -> Uri

Public Overridable Function GenerateUserDelegationSasUri (permissions As DataLakeFileSystemSasPermissions, expiresOn As DateTimeOffset, userDelegationKey As UserDelegationKey) 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.

userDelegationKey

UserDelegationKey

Required. A UserDelegationKey returned from GetUserDelegationKeyAsync(Nullable<DateTimeOffset>, DateTimeOffset, CancellationToken).

Returns

Uri

A Uri containing the SAS Uri.

Remarks

A Exception will be thrown if a failure occurs.