Package version:

Interface BlobGenerateSasUrlOptions

Options to configure BlobClient.generateSasUrl operation.

interface BlobGenerateSasUrlOptions {
    cacheControl?: string;
    contentDisposition?: string;
    contentEncoding?: string;
    contentLanguage?: string;
    contentType?: string;
    delegatedUserObjectId?: string;
    encryptionScope?: string;
    expiresOn?: any;
    identifier?: string;
    ipRange?: SasIPRange;
    permissions?: BlobSASPermissions;
    protocol?: SASProtocol;
    startsOn?: any;
    version?: string;
}

Hierarchy (view full)

Properties

cacheControl? contentDisposition? contentEncoding? contentLanguage? contentType? delegatedUserObjectId? encryptionScope? 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.

OptionaldelegatedUserObjectId

delegatedUserObjectId?: string

Optional. Beginning in version 2025-07-05, this value specifies the Entra ID of the user would is authorized to use the resulting SAS URL. The resulting SAS URL must be used in conjunction with an Entra ID token that has been issued to the user specified in this value.

OptionalencryptionScope

encryptionScope?: string

Optional. Encryption scope to use when sending requests authorized with this SAS URI.

OptionalexpiresOn

expiresOn?: any

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 container this SAS references if any.

See

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

OptionalipRange

ipRange?: SasIPRange

Optional. IP ranges allowed in this SAS.

Optionalpermissions

permissions?: BlobSASPermissions

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?: any

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