Share via

DataLakePathClient.GenerateUserDelegationSasUri Method

  • Reference

Definition

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

Overloads

GenerateUserDelegationSasUri(DataLakeSasBuilder, UserDelegationKey)

The GenerateUserDelegationSasUri(DataLakeSasBuilder, UserDelegationKey) returns a Uri that generates a DataLake Path 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(DataLakeSasPermissions, DateTimeOffset, UserDelegationKey)

The GenerateUserDelegationSasUri(DataLakeSasPermissions, DateTimeOffset, UserDelegationKey) returns a Uri that generates a DataLake Path Service Shared Access Signature (SAS) Uri based on the Client properties and parameter 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:
DataLakePathClient.cs

The GenerateUserDelegationSasUri(DataLakeSasBuilder, UserDelegationKey) returns a Uri that generates a DataLake Path 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 Uri containing the SAS Uri.

Remarks

A Exception will be thrown if a failure occurs.

Applies to

GenerateUserDelegationSasUri(DataLakeSasPermissions, DateTimeOffset, UserDelegationKey)

Source:
DataLakePathClient.cs

The GenerateUserDelegationSasUri(DataLakeSasPermissions, DateTimeOffset, UserDelegationKey) returns a Uri that generates a DataLake Path Service Shared Access Signature (SAS) Uri based on the Client properties and parameter 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.DataLakeSasPermissions permissions, DateTimeOffset expiresOn, Azure.Storage.Files.DataLake.Models.UserDelegationKey userDelegationKey);
abstract member GenerateUserDelegationSasUri : Azure.Storage.Sas.DataLakeSasPermissions * DateTimeOffset * Azure.Storage.Files.DataLake.Models.UserDelegationKey -> Uri
override this.GenerateUserDelegationSasUri : Azure.Storage.Sas.DataLakeSasPermissions * DateTimeOffset * Azure.Storage.Files.DataLake.Models.UserDelegationKey -> Uri
Public Overridable Function GenerateUserDelegationSasUri (permissions As DataLakeSasPermissions, expiresOn As DateTimeOffset, userDelegationKey As UserDelegationKey) As Uri

Parameters

permissions
DataLakeSasPermissions

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

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.

Applies to