Package version:

Interface FileGenerateSasUrlOptions

Options to configure ShareFileClient.generateSasUrl operation.

interface FileGenerateSasUrlOptions {
    cacheControl?: string;
    contentDisposition?: string;
    contentEncoding?: string;
    contentLanguage?: string;
    contentType?: string;
    expiresOn?: Date;
    identifier?: string;
    ipRange?: SasIPRange;
    permissions?: FileSASPermissions;
    protocol?: SASProtocol;
    startsOn?: Date;
    version?: string;
}

Hierarchy (view full)

Properties

cacheControl? contentDisposition? contentEncoding? contentLanguage? contentType? expiresOn? identifier? ipRange? permissions? protocol? startsOn? version?

Properties

OptionalcacheControl

cacheControl?: string

Optional. The cache-control header for the SAS.

OptionalcontentDisposition

contentDisposition?: string

Optional. The content-disposition header for the SAS.

OptionalcontentEncoding

contentEncoding?: string

Optional. The content-encoding header for the SAS.

OptionalcontentLanguage

contentLanguage?: string

Optional. The content-language header for the SAS.

OptionalcontentType

contentType?: string

Optional. The content-type header for the SAS.

OptionalexpiresOn

expiresOn?: Date

Optional only when identifier is provided. The time after which the SAS will no longer work.

Optionalidentifier

identifier?: string

Optional. The name of the access policy on the share this SAS references if any.

See

https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy

OptionalipRange

ipRange?: SasIPRange

Optional. IP ranges allowed in this SAS.

Optionalpermissions

permissions?: FileSASPermissions

Optional only when identifier is provided. Specifies the list of permissions to be associated with the SAS.

Optionalprotocol

protocol?: SASProtocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

OptionalstartsOn

startsOn?: Date

Optional. When the SAS will take effect.

Optionalversion

version?: string

The version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

Settings

Member Visibility