SASQueryParameters class

Balíček:

@azure/storage-blob

Představuje komponenty, které tvoří parametry dotazu SAS služby Azure Storage. Tento typ není vytvořen přímo uživatelem; Generuje se pouze typy AccountSASSignatureValues a BlobSASSignatureValues . Po vygenerování se dá zakódovat do toString() a připojit k adrese URL přímo (i když byste měli být opatrní v případě, že existují parametry dotazu, které by mohly ovlivnit vhodné způsoby připojení těchto parametrů dotazu).

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

Konstruktory

SASQueryParameters(string, string, SASQueryParametersOptions)	Vytvoří instanci SASQueryParameters.
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, 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 content-length v SAS služby Blob/File Service
contentType	Hodnota hlavičky content-type v SAS služby Blob/File Service.
correlationId	Hodnota GUID, která se zaprotokoluje v diagnostických protokolech úložiště a dá se použít ke korelaci generování SAS s přístupem k prostředkům úložiště. Používá se pouze pro SAS delegování uživatelů.
encryptionScope	Nepovinný parametr. Obor šifrování, který se má použít při odesílání požadavků autorizovaných pomocí tohoto identifikátoru URI SAS.
expiresOn	Volitelné pouze v případě, že je zadaný identifikátor. Doba vypršení platnosti tohoto tokenu SAS.
identifier	Nepovinný parametr. Podepsaný identifikátor (pouze pro BlobSASSignatureValues). Viz https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy.
ipRange	Nepovinný parametr. Povolený rozsah IP adres pro tento sdílený přístupový podpis.
permissions	Volitelné pouze v případě, že je zadaný identifikátor. Další podrobnosti najdete v tématu AccountSASPermissions, BlobSASPermissions nebo ContainerSASPermissions .
preauthorizedAgentObjectId	ID autorizovaného objektu AAD ve formátu GUID. ID objektu AAD uživatele autorizovaného vlastníkem klíče delegování uživatele k provedení akce udělené sdíleným přístupovým podpisem. Služba Azure Storage před udělením přístupu zajistí, že vlastník klíče delegování uživatele má požadovaná oprávnění, ale neprovedou se žádné další kontroly oprávnění pro uživatele zadaného v této hodnotě. Používá se pouze pro SAS delegování uživatelů.
protocol	Nepovinný parametr. Povolené protokoly HTTP
resource	Nepovinný parametr. Určuje, které prostředky jsou přístupné prostřednictvím sdíleného přístupového podpisu (pouze pro BlobSASSignatureValues). Viz https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only.
resourceTypes	Nepovinný parametr. Typy prostředků úložiště, ke které se přistupuje (pouze pro SAS účtu). Další podrobnosti najdete v tématu AccountSASResourceTypes .
services	Nepovinný parametr. Služby úložiště, ke které přistupujete (pouze pro SAS účtu). Další podrobnosti najdete v tématu AccountSASServices .
signature	Podpis tokenu SAS.
startsOn	Nepovinný parametr. Čas spuštění 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, SASQueryParametersOptions)

Vytvoří instanci SASQueryParameters.

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

Parametry

version

string

Reprezentace verze úložiště

signature

string

Reprezentace podpisu pro token SAS

options

SASQueryParametersOptions

Nepovinný parametr. Možnosti pro vytvoření SASQueryParameters.

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

Parametry

version

string

Reprezentace verze úložiště

signature

string

Reprezentace podpisu pro token SAS

permissions

string

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

services

string

Reprezentace služeb úložiště, ke které přistupujete (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

Reprezentace rozsahu platných IP adres pro tento token SAS

identifier

string

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

resource

string

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

cacheControl

string

Reprezentace hlavičky řízení mezipaměti (pouze pro SAS služby Blob/File Service)

contentDisposition

string

Představuje hlavičku 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

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

contentType

string

Představuje hlavičku content-type (jenom pro SAS služby Blob/File Service)

userDelegationKey

UserDelegationKey

Reprezentace vlastností klíče delegování uživatele

preauthorizedAgentObjectId

string

Reprezentace ID autorizovaného objektu AAD (pouze pro SAS delegování uživatele)

correlationId

string

Reprezentace ID korelace (pouze pro SAS delegování uživatele)

encryptionScope

string

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 content-length v SAS služby Blob/File Service

contentLanguage?: string

Hodnota vlastnosti

string

contentType

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

contentType?: string

Hodnota vlastnosti

string

correlationId

Hodnota GUID, která se zaprotokoluje v diagnostických protokolech úložiště a dá se použít ke korelaci generování SAS s přístupem k prostředkům úložiště. Používá se pouze pro SAS delegování uživatelů.

correlationId?: string

Hodnota vlastnosti

string

encryptionScope

Nepovinný parametr. Obor šifrování, který se má použít při odesílání požadavků autorizovaných pomocí tohoto identifikátoru URI SAS.

encryptionScope?: 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

Nepovinný parametr. Podepsaný identifikátor (pouze pro BlobSASSignatureValues).

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

identifier?: string

Hodnota vlastnosti

string

ipRange

Nepovinný parametr. Povolený rozsah IP adres pro tento sdílený přístupový podpis.

undefined | SasIPRange ipRange

Hodnota vlastnosti

undefined | SasIPRange

permissions

Volitelné pouze v případě, že je zadaný identifikátor. Další podrobnosti najdete v tématu AccountSASPermissions, BlobSASPermissions nebo ContainerSASPermissions .

permissions?: string

Hodnota vlastnosti

string

preauthorizedAgentObjectId

ID autorizovaného objektu AAD ve formátu GUID. ID objektu AAD uživatele autorizovaného vlastníkem klíče delegování uživatele k provedení akce udělené sdíleným přístupovým podpisem. Služba Azure Storage před udělením přístupu zajistí, že vlastník klíče delegování uživatele má požadovaná oprávnění, ale neprovedou se žádné další kontroly oprávnění pro uživatele zadaného v této hodnotě. Používá se pouze pro SAS delegování uživatelů.

preauthorizedAgentObjectId?: string

Hodnota vlastnosti

string

protocol

Nepovinný parametr. Povolené protokoly HTTP

protocol?: SASProtocol

Hodnota vlastnosti

SASProtocol

resource

Nepovinný parametr. Určuje, které prostředky jsou přístupné prostřednictvím sdíleného přístupového podpisu (pouze pro BlobSASSignatureValues).

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

resource?: string

Hodnota vlastnosti

string

resourceTypes

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

resourceTypes?: string

Hodnota vlastnosti

string

services

Nepovinný parametr. Služby úložiště, ke které přistupujete (pouze pro SAS účtu). Další podrobnosti najdete v tématu AccountSASServices .

services?: string

Hodnota vlastnosti

string

signature

Podpis tokenu SAS.

signature: string

Hodnota vlastnosti

string

startsOn

Nepovinný parametr. Čas spuštění 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