SASQueryParameters class

Odwołanie

Pakiet:: @azure/storage-blob

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 BlobSASSignatureValues . 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, SASQueryParametersOptions)	Tworzy wystąpienie parametrów SASQueryParameters.
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, 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.
correlationId	Wartość identyfikatora GUID, która zostanie zarejestrowana w dziennikach diagnostycznych magazynu i może służyć do korelowania generowania sygnatur dostępu współdzielonego z dostępem do zasobów magazynu. Jest to używane tylko w przypadku sygnatury dostępu współdzielonego delegowania użytkownika.
encryptionScope	Opcjonalny. Zakres szyfrowania do użycia podczas wysyłania żądań autoryzowanych za pomocą tego identyfikatora URI sygnatury dostępu współdzielonego.
expiresOn	Opcjonalne tylko w przypadku podania identyfikatora. Czas wygaśnięcia tego tokenu SYGNATURy dostępu współdzielonego.
identifier	Opcjonalny. Podpisany identyfikator (tylko dla obiektów BlobSASSignatureValues). 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, BlobSASPermissions lub ContainerSASPermissions .
preauthorizedAgentObjectId	Autoryzowany identyfikator obiektu usługi AAD w formacie GUID. Identyfikator obiektu usługi AAD użytkownika autoryzowanego przez właściciela klucza delegowania użytkownika do wykonania akcji udzielonej przez sygnaturę dostępu współdzielonego. Usługa Azure Storage zapewni, że właściciel klucza delegowania użytkownika ma wymagane uprawnienia przed udzieleniem dostępu, ale nie zostanie wykonana żadna dodatkowa kontrola uprawnień dla użytkownika określonego w tej wartości. Jest to używane tylko w przypadku sygnatury dostępu współdzielonego delegowania użytkownika.
protocol	Opcjonalny. Dozwolone protokoły HTTP.
resource	Opcjonalny. Określa, które zasoby są dostępne za pośrednictwem sygnatury dostępu współdzielonego (tylko dla obiektów BlobSASSignatureValues). Zobacz https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
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

SASQueryParameters(string, string, SASQueryParametersOptions)

Tworzy wystąpienie parametrów SASQueryParameters.

new SASQueryParameters(version: string, signature: string, options?: SASQueryParametersOptions)

Parametry

version: string

Reprezentowanie wersji magazynu

signature: string

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

options: SASQueryParametersOptions

Opcjonalny. Opcje konstruowania parametrów SASQueryParameters.

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, 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, userDelegationKey?: UserDelegationKey, preauthorizedAgentObjectId?: string, correlationId?: string, encryptionScope?: 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)

userDelegationKey: UserDelegationKey

Reprezentowanie właściwości klucza delegowania użytkownika

preauthorizedAgentObjectId: string

Reprezentowanie autoryzowanego identyfikatora obiektu usługi AAD (tylko dla sygnatury dostępu współdzielonego delegowania użytkownika)

correlationId: string

Reprezentowanie identyfikatora korelacji (tylko dla sygnatury dostępu współdzielonego delegowania użytkownika)

encryptionScope: string

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

correlationId

Wartość identyfikatora GUID, która zostanie zarejestrowana w dziennikach diagnostycznych magazynu i może służyć do korelowania generowania sygnatur dostępu współdzielonego z dostępem do zasobów magazynu. Jest to używane tylko w przypadku sygnatury dostępu współdzielonego delegowania użytkownika.

correlationId?: string

Wartość właściwości

string

encryptionScope

Opcjonalny. Zakres szyfrowania do użycia podczas wysyłania żądań autoryzowanych za pomocą tego identyfikatora URI sygnatury dostępu współdzielonego.

encryptionScope?: string

Wartość właściwości

string

expiresOn

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

identifier

Opcjonalny. Podpisany identyfikator (tylko dla obiektów BlobSASSignatureValues).

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

identifier?: string

Wartość właściwości

string

ipRange

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

undefined | SasIPRange ipRange

Wartość właściwości

undefined | SasIPRange

permissions

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

permissions?: string

Wartość właściwości

string

preauthorizedAgentObjectId

Autoryzowany identyfikator obiektu usługi AAD w formacie GUID. Identyfikator obiektu usługi AAD użytkownika autoryzowanego przez właściciela klucza delegowania użytkownika do wykonania akcji udzielonej przez sygnaturę dostępu współdzielonego. Usługa Azure Storage zapewni, że właściciel klucza delegowania użytkownika ma wymagane uprawnienia przed udzieleniem dostępu, ale nie zostanie wykonana żadna dodatkowa kontrola uprawnień dla użytkownika określonego w tej wartości. Jest to używane tylko w przypadku sygnatury dostępu współdzielonego delegowania użytkownika.

preauthorizedAgentObjectId?: string

Wartość właściwości

string

protocol

Opcjonalny. Dozwolone protokoły HTTP.

protocol?: SASProtocol

Wartość właściwości

SASProtocol

resource

Opcjonalny. Określa, które zasoby są dostępne za pośrednictwem sygnatury dostępu współdzielonego (tylko dla obiektów BlobSASSignatureValues).

Zobacz https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only

resource?: string

Wartość właściwości

string

resourceTypes

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

services

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

signature

Podpis tokenu SYGNATURY dostępu współdzielonego.

signature: string

Wartość właściwości

string

startsOn

Opcjonalny. Godzina rozpoczęcia 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 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

SASQueryParameters(string, string, SASQueryParametersOptions)

Parametry

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

Parametry

Szczegóły właściwości

cacheControl

Wartość właściwości

contentDisposition

Wartość właściwości

contentEncoding

Wartość właściwości

contentLanguage

Wartość właściwości

contentType

Wartość właściwości

correlationId

Wartość właściwości

encryptionScope

Wartość właściwości

expiresOn

Wartość właściwości

identifier

Wartość właściwości

ipRange

Wartość właściwości

permissions

Wartość właściwości

preauthorizedAgentObjectId

Wartość właściwości

protocol

Wartość właściwości

resource

Wartość właściwości

resourceTypes

Wartość właściwości

services

Wartość właściwości

signature

Wartość właściwości

startsOn

Wartość właściwości

version

Wartość właściwości

Szczegóły metody

toString()

Zwraca

Dodatkowe zasoby