Udostępnij za pośrednictwem

SASQueryParameters class

  • Odwołanie
Pakiet:
@azure/storage-queue

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 QueueSASSignatureValues . 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)

Tworzy wystąpienie parametrów SASQueryParameters.

Właściwości

expiresOn

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

Opcjonalny. Podpisany identyfikator (tylko dla elementu QueueSASSignatureValues).

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, QueueSASPermissions .
protocol

Opcjonalny. Dozwolone protokoły HTTP.
resource

Opcjonalny. Kolejka magazynu (tylko dla queueSASSignatureValues).
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, string, string, string, SASProtocol, Date, Date, SasIPRange, 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)

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 kolejki magazynu (tylko dla sygnatury dostępu współdzielonego usługi)

Szczegóły właściwości

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 elementu QueueSASSignatureValues).

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, QueueSASPermissions .

permissions?: string

Wartość właściwości

string

protocol

Opcjonalny. Dozwolone protokoły HTTP.

protocol?: SASProtocol

Wartość właściwości

SASProtocol

resource

Opcjonalny. Kolejka magazynu (tylko dla queueSASSignatureValues).

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