SASQueryParameters class

Balíček:

@azure/storage-file-share

Představuje komponenty, které tvoří parametry dotazu SAS služby Azure Storage. Tento typ není vytvořen přímo uživatelem; generuje se pouze AccountSASSignatureValues a FileSASSignatureValues typy. Po vygenerování je možné ho zakódovat do toString() a připojit se přímo k adrese URL (v případě, že existují existující parametry dotazu, které by mohly ovlivnit vhodné prostředky připojení těchto parametrů dotazu).

POZNÁMKA: Instance této třídy jsou neměnné.

Konstruktory

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string)

Vytvoří instanci SASQueryParameters.

Vlastnosti

cacheControl	Hodnota hlavičky řízení mezipaměti v SAS služby Blob/File Service
contentDisposition	Hodnota hlavičky content-disposition v SAS služby Blob/File Service
contentEncoding	Hodnota hlavičky kódování obsahu v SAS služby Blob/File Service
contentLanguage	Hodnota hlavičky délky obsahu v SAS služby Blob/File Service
contentType	Hodnota hlavičky typu obsahu v SAS služby Blob/File Service
expiresOn	Volitelné pouze v případě, že je zadaný identifikátor. Doba vypršení platnosti tohoto tokenu SAS.
identifier	Optional. Podepsaný identifikátor (pouze pro FileSASSignatureValues). Viz https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Optional. Povolený rozsah IP adres pro tento SAS.
permissions	Volitelné pouze v případě, že je zadaný identifikátor. Další podrobnosti najdete v accountSASPermissions, FileSASPermissionsnebo ShareSASPermissions.
protocol	Optional. Povolené protokoly HTTP.
resource	Optional. Sdílená složka úložiště nebo cesta k souboru (pouze pro FileSASSignatureValues).
resourceTypes	Optional. Typy prostředků úložiště, ke které se přistupuje (pouze pro SAS účtu). Další podrobnosti najdete v AccountSASResourceTypes.
services	Optional. Přístup ke službám úložiště (pouze pro SAS účtu) Další podrobnosti najdete v AccountSASServices.
signature	Podpis tokenu SAS.
startsOn	Optional. Čas zahájení tohoto tokenu SAS.
version	Verze rozhraní API úložiště.

Metody

toString()

Zakóduje všechny parametry dotazu SAS do řetězce, který lze připojit k adrese URL.

Podrobnosti konstruktoru

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string)

Vytvoří instanci SASQueryParameters.

new SASQueryParameters(version: string, signature: string, permissions?: string, services?: string, resourceTypes?: string, protocol?: SASProtocol, startsOn?: Date, expiresOn?: Date, ipRange?: SasIPRange, identifier?: string, resource?: string, cacheControl?: string, contentDisposition?: string, contentEncoding?: string, contentLanguage?: string, contentType?: string)

Parametry

version

string

Reprezentace verze úložiště

signature

string

Reprezentace podpisu tokenu SAS

permissions

string

Reprezentace oprávnění k úložišti

services

string

Reprezentace služeb úložiště, ke které se přistupuje (pouze pro SAS účtu)

resourceTypes

string

Reprezentace typů prostředků úložiště, ke které se přistupuje (pouze pro SAS účtu)

protocol

SASProtocol

Reprezentace povolených protokolů HTTP

startsOn

Date

Představuje počáteční čas pro tento token SAS.

expiresOn

Date

Představuje dobu vypršení platnosti tohoto tokenu SAS.

ipRange

SasIPRange

Představuje rozsah platných IP adres pro tento token SAS.

identifier

string

Reprezentace podepsaného identifikátoru (pouze pro SAS služby)

resource

string

Reprezentace kontejneru úložiště nebo objektu blob (pouze pro SAS služby)

cacheControl

string

Reprezentace hlavičky ovládacího prvku mezipaměti (pouze pro SAS služby Blob/File Service)

contentDisposition

string

Reprezentace hlavičky content-disposition (pouze pro SAS služby Blob/File Service)

contentEncoding

string

Reprezentace hlavičky kódování obsahu (pouze pro SAS služby Blob/File Service)

contentLanguage

string

Reprezentace hlavičky jazyka obsahu (pouze pro SAS služby Blob/File Service)

contentType

string

Představuje hlavičku typu obsahu (pouze pro SAS služby Blob/File Service).

Podrobnosti vlastnosti

cacheControl

Hodnota hlavičky řízení mezipaměti v SAS služby Blob/File Service

cacheControl?: string

Hodnota vlastnosti

string

contentDisposition

Hodnota hlavičky content-disposition v SAS služby Blob/File Service

contentDisposition?: string

Hodnota vlastnosti

string

contentEncoding

Hodnota hlavičky kódování obsahu v SAS služby Blob/File Service

contentEncoding?: string

Hodnota vlastnosti

string

contentLanguage

Hodnota hlavičky délky obsahu v SAS služby Blob/File Service

contentLanguage?: string

Hodnota vlastnosti

string

contentType

Hodnota hlavičky typu obsahu v SAS služby Blob/File Service

contentType?: string

Hodnota vlastnosti

string

expiresOn

Volitelné pouze v případě, že je zadaný identifikátor. Doba vypršení platnosti tohoto tokenu SAS.

expiresOn?: Date

Hodnota vlastnosti

Date

identifier

Optional. Podepsaný identifikátor (pouze pro FileSASSignatureValues).

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

identifier?: string

Hodnota vlastnosti

string

ipRange

Optional. Povolený rozsah IP adres pro tento SAS.

undefined | SasIPRange ipRange

Hodnota vlastnosti

undefined | SasIPRange

permissions

Volitelné pouze v případě, že je zadaný identifikátor. Další podrobnosti najdete v accountSASPermissions, FileSASPermissionsnebo ShareSASPermissions.

permissions?: string

Hodnota vlastnosti

string

protocol

Optional. Povolené protokoly HTTP.

protocol?: SASProtocol

Hodnota vlastnosti

SASProtocol

resource

Optional. Sdílená složka úložiště nebo cesta k souboru (pouze pro FileSASSignatureValues).

resource?: string

Hodnota vlastnosti

string

resourceTypes

Optional. Typy prostředků úložiště, ke které se přistupuje (pouze pro SAS účtu). Další podrobnosti najdete v AccountSASResourceTypes.

resourceTypes?: string

Hodnota vlastnosti

string

services

Optional. Přístup ke službám úložiště (pouze pro SAS účtu) Další podrobnosti najdete v AccountSASServices.

services?: string

Hodnota vlastnosti

string

signature

Podpis tokenu SAS.

signature: string

Hodnota vlastnosti

string

startsOn

Optional. Čas zahájení tohoto tokenu SAS.

startsOn?: Date

Hodnota vlastnosti

Date

version

Verze rozhraní API úložiště.

version: string

Hodnota vlastnosti

string

Podrobnosti metody

toString()

Zakóduje všechny parametry dotazu SAS do řetězce, který lze připojit k adrese URL.

function toString(): string

Návraty

string