Package version:

Interface QueueGenerateSasUrlOptions

Options to configure QueueClient.generateSasUrl operation.

interface QueueGenerateSasUrlOptions {
    expiresOn?: any;
    identifier?: string;
    ipRange?: SasIPRange;
    permissions?: QueueSASPermissions;
    protocol?: SASProtocol;
    startsOn?: any;
    version?: string;
}

Properties

expiresOn? identifier? ipRange? permissions? protocol? startsOn? version?

Properties

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 queue 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?: QueueSASPermissions

Optional only when identifier is provided. Please refer to QueueSASPermissions for help constructing the permissions string.

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