SASQueryParameters class

Odwołanie

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 FileSASSignatureValues . Po wygenerowaniu można je kodować bezpośrednio do toString() adresu URL i dołączać do niego (należy zachować ostrożność w przypadku, gdy istnieją parametry zapytania, które mogą mieć wpływ na odpowiednie sposoby 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	Opcjonalne tylko w przypadku podania identyfikatora. Czas wygaśnięcia tego tokenu SYGNATURy dostępu współdzielonego.
identifier	Opcjonalny. Podpisany identyfikator (tylko dla wartości FileSASSignatureValues). Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Opcjonalny. Zakres adresów IP dozwolony dla tej sygnatury dostępu współdzielonego.
permissions	Opcjonalne tylko w przypadku podania identyfikatora. Aby uzyskać więcej informacji, zobacz AccountSASPermissions, FileSASPermissions lub ShareSASPermissions .
protocol	Opcjonalny. Dozwolone protokoły HTTP.
resource	Opcjonalny. Udział magazynu lub ścieżka pliku (tylko dla fileSASSignatureValues).
resourceTypes	Opcjonalny. Używane typy zasobów magazynu (tylko dla sygnatury dostępu współdzielonego konta). Aby uzyskać więcej informacji, zobacz AccountSASResourceTypes .
services	Opcjonalny. Dostęp do usług magazynu (tylko dla sygnatury dostępu współdzielonego konta). Aby uzyskać więcej informacji, zobacz AccountSASServices .
signature	Podpis tokenu SYGNATURY dostępu współdzielonego.
startsOn	Opcjonalny. Godzina rozpoczęcia tego tokenu SYGNATURy dostępu współdzielonego.
version	Wersja interfejsu API magazynu.

Metody

toString()

Koduje wszystkie parametry zapytania SYGNATURy dostępu współdzielonego do ciągu, który można dołączyć do adresu URL.

Szczegóły konstruktora

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 jest uzyskiwany dostęp (tylko dla sygnatury dostępu współdzielonego konta)

resourceTypes: string

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

protocol: SASProtocol

Reprezentowanie dozwolonych protokołów HTTP

startsOn: Date

Reprezentacja czasu rozpoczęcia dla tego tokenu SYGNATURy dostępu współdzielonego

expiresOn: Date

Reprezentowanie czasu wygaśnięcia dla tego tokenu SYGNATURy dostępu współdzielonego

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 blob/file service)

contentEncoding: string

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

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/file service)

Szczegóły właściwości

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

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

contentDisposition?: string

Wartość właściwości

string

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

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

contentLanguage?: string

Wartość właściwości

string

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

Opcjonalne tylko w przypadku podania identyfikatora. Czas wygaśnięcia tego tokenu SYGNATURy dostępu współdzielonego.

expiresOn?: Date

Wartość właściwości

Date

Opcjonalny. Podpisany identyfikator (tylko dla wartości FileSASSignatureValues).

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

identifier?: string

Wartość właściwości

string

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

undefined | SasIPRange ipRange

Wartość właściwości

undefined | SasIPRange

Opcjonalne tylko w przypadku podania identyfikatora. Aby uzyskać więcej informacji, zobacz AccountSASPermissions, FileSASPermissions lub ShareSASPermissions .

permissions?: string

Wartość właściwości

string

Opcjonalny. Dozwolone protokoły HTTP.

protocol?: SASProtocol

Wartość właściwości

SASProtocol

Opcjonalny. Udział magazynu lub ścieżka pliku (tylko dla fileSASSignatureValues).

resource?: string

Wartość właściwości

string

Opcjonalny. Używane typy 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

Opcjonalny. 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

Podpis tokenu SYGNATURY dostępu współdzielonego.

signature: string

Wartość właściwości

string

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

startsOn?: Date

Wartość właściwości

Date

Wersja interfejsu API magazynu.

version: string

Wartość właściwości

string

Szczegóły metody

Koduje wszystkie parametry zapytania SYGNATURy dostępu współdzielonego do ciągu, który można dołączyć do adresu URL.

function toString(): string

Zwraca

string

Udostępnij za pośrednictwem

SASQueryParameters class

Konstruktory

Właściwości

Metody

Szczegóły konstruktora

Parametry

Szczegóły właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Wartość właściwości

Szczegóły metody

Zwraca

Dodatkowe zasoby