SASQueryParameters class

Pakiet:

@azure/storage-file-share

Reprezentuje składniki tworzące parametry zapytania sygnatury dostępu współdzielonego usługi Azure Storage. Ten typ nie jest konstruowany bezpośrednio przez użytkownika; Jest on generowany tylko przez typy AccountSASSignatureValues i FileSASSignatureValue s. Po wygenerowaniu można je kodować w toString() i dołączać bezpośrednio do adresu URL (należy jednak zachować ostrożność w przypadku istnienia parametrów zapytania, co może mieć wpływ na odpowiednie środki dołączania tych parametrów zapytania).

UWAGA: Wystąpienia tej klasy są niezmienne.

Konstruktory

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

Tworzy wystąpienie parametrów SASQueryParameters.

Właściwości

cacheControl	Wartość nagłówka kontrolki pamięci podręcznej w sygnaturze dostępu współdzielonego usługi blob/file service.
contentDisposition	Wartość nagłówka content-disposition w sygnaturze dostępu współdzielonego usługi blob/file service.
contentEncoding	Wartość nagłówka kodowania zawartości w sygnaturze dostępu współdzielonego usługi blob/file service.
contentLanguage	Wartość nagłówka zawartości w sygnaturze dostępu współdzielonego usługi blob/file service.
contentType	Wartość nagłówka typu zawartości w sygnaturze dostępu współdzielonego usługi blob/file service.
expiresOn	Opcjonalnie tylko w przypadku podania identyfikatora. Czas wygaśnięcia dla tego tokenu SAS.
identifier	Optional. Podpisany identyfikator (tylko dla FileSASSignatureValues). Zobacz https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Optional. Zakres adresów IP dozwolony dla tej sygnatury dostępu współdzielonego.
permissions	Opcjonalnie tylko w przypadku podania identyfikatora. Aby uzyskać więcej informacji, zobacz AccountSASPermissions, FileSASPermissionslub ShareSASPermissions.
protocol	Optional. Dozwolone protokoły HTTP.
resource	Optional. Udział magazynu lub ścieżka pliku (tylko dla FileSASSignatureValues).
resourceTypes	Optional. Dostęp do typów zasobów magazynu (tylko dla sygnatury dostępu współdzielonego konta). Aby uzyskać więcej informacji, zobacz AccountSASResourceTypes.
services	Optional. Dostęp do usług magazynu (tylko dla sygnatury dostępu współdzielonego konta). Aby uzyskać więcej informacji, zobacz AccountSASServices.
signature	Podpis tokenu SAS.
startsOn	Optional. Godzina rozpoczęcia dla tego tokenu SYGNATURy dostępu współdzielonego.
version	Wersja interfejsu API magazynu.

Metody

toString()

Koduje wszystkie parametry zapytania SAS do ciągu, który można dołączyć do adresu URL.

Szczegóły konstruktora

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

Tworzy wystąpienie parametrów 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

Reprezentowanie wersji magazynu

signature

string

Reprezentowanie podpisu dla tokenu SYGNATURY dostępu współdzielonego

permissions

string

Reprezentowanie uprawnień magazynu

services

string

Reprezentowanie usług magazynu, do których uzyskuje się dostęp (tylko dla sygnatury dostępu współdzielonego konta)

resourceTypes

string

Reprezentowanie używanych typów zasobów magazynu (tylko dla sygnatury dostępu współdzielonego konta)

protocol

SASProtocol

Reprezentowanie dozwolonych protokołów HTTP

startsOn

Date

Reprezentacja czasu rozpoczęcia dla tego tokenu SAS

expiresOn

Date

Reprezentowanie czasu wygaśnięcia dla tego tokenu SAS

ipRange

SasIPRange

Reprezentowanie zakresu prawidłowych adresów IP dla tego tokenu SAS

identifier

string

Reprezentowanie podpisanego identyfikatora (tylko dla sygnatury dostępu współdzielonego usługi)

resource

string

Reprezentowanie kontenera magazynu lub obiektu blob (tylko dla sygnatury dostępu współdzielonego usługi)

cacheControl

string

Reprezentowanie nagłówka kontrolki pamięci podręcznej (tylko dla sygnatury dostępu współdzielonego usługi blob/file service)

contentDisposition

string

Reprezentowanie nagłówka content-disposition (tylko dla sygnatury dostępu współdzielonego usługi obiektów blob/plików)

contentEncoding

string

Reprezentowanie nagłówka kodowania zawartości (tylko dla sygnatury dostępu współdzielonego usługi obiektów blob/plików)

contentLanguage

string

Reprezentowanie nagłówka języka zawartości (tylko dla sygnatury dostępu współdzielonego usługi blob/file service)

contentType

string

Reprezentowanie nagłówka typu zawartości (tylko dla sygnatury dostępu współdzielonego usługi blob/plików)

Szczegóły właściwości

cacheControl

Wartość nagłówka kontrolki pamięci podręcznej w sygnaturze dostępu współdzielonego usługi blob/file service.

cacheControl?: string

Wartość właściwości

string

contentDisposition

Wartość nagłówka content-disposition w sygnaturze dostępu współdzielonego usługi blob/file service.

contentDisposition?: string

Wartość właściwości

string

contentEncoding

Wartość nagłówka kodowania zawartości w sygnaturze dostępu współdzielonego usługi blob/file service.

contentEncoding?: string

Wartość właściwości

string

contentLanguage

Wartość nagłówka zawartości w sygnaturze dostępu współdzielonego usługi blob/file service.

contentLanguage?: string

Wartość właściwości

string

contentType

Wartość nagłówka typu zawartości w sygnaturze dostępu współdzielonego usługi blob/file service.

contentType?: string

Wartość właściwości

string

expiresOn

Opcjonalnie tylko w przypadku podania identyfikatora. Czas wygaśnięcia dla tego tokenu SAS.

expiresOn?: Date

Wartość właściwości

Date

identifier

Optional. Podpisany identyfikator (tylko dla FileSASSignatureValues).

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

identifier?: string

Wartość właściwości

string

ipRange

Optional. Zakres adresów IP dozwolony dla tej sygnatury dostępu współdzielonego.

undefined | SasIPRange ipRange

Wartość właściwości

undefined | SasIPRange

permissions

Opcjonalnie tylko w przypadku podania identyfikatora. Aby uzyskać więcej informacji, zobacz AccountSASPermissions, FileSASPermissionslub ShareSASPermissions.

permissions?: string

Wartość właściwości

string

protocol

Optional. Dozwolone protokoły HTTP.

protocol?: SASProtocol

Wartość właściwości

SASProtocol

resource

Optional. Udział magazynu lub ścieżka pliku (tylko dla FileSASSignatureValues).

resource?: string

Wartość właściwości

string

resourceTypes

Optional. Dostęp do typów zasobów magazynu (tylko dla sygnatury dostępu współdzielonego konta). Aby uzyskać więcej informacji, zobacz AccountSASResourceTypes.

resourceTypes?: string

Wartość właściwości

string

services

Optional. Dostęp do usług magazynu (tylko dla sygnatury dostępu współdzielonego konta). Aby uzyskać więcej informacji, zobacz AccountSASServices.

services?: string

Wartość właściwości

string

signature

Podpis tokenu SAS.

signature: string

Wartość właściwości

string

startsOn

Optional. Godzina rozpoczęcia dla tego tokenu SYGNATURy dostępu współdzielonego.

startsOn?: Date

Wartość właściwości

Date

version

Wersja interfejsu API magazynu.

version: string

Wartość właściwości

string

Szczegóły metody

toString()

Koduje wszystkie parametry zapytania SAS do ciągu, który można dołączyć do adresu URL.

function toString(): string

Zwraca

string