Sdílet prostřednictvím

SASQueryParameters class

  • Reference
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 AccountSASSignatureValues a BlobSASSignatureValues typech. Po vygenerování je možné ho zakódovat do toString() a připojit se přímo k adrese URL (v případě, že existují existující parametry dotazu, které by mohly ovlivnit vhodné prostředky 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 délky obsahu v SAS služby Blob/File Service
contentType

Hodnota hlavičky typu obsahu v SAS služby Blob/File Service
correlationId

Hodnota GUID, která se bude protokolovat 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 jenom pro SAS delegování uživatele.
encryptionScope

Volitelný. 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

Volitelný. Podepsaný identifikátor (pouze pro BlobSASSignatureValues).

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

Volitelný. Povolený rozsah IP adres pro tento SAS.
permissions

Volitelné pouze v případě, že je zadaný identifikátor. Další podrobnosti najdete v AccountSASPermissions, BlobSASPermissionsnebo ContainerSASPermission s.
preauthorizedAgentObjectId

Autorizované ID 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é SAS. Služba Azure Storage zajistí, že vlastník klíče delegování uživatele má před udělením přístupu požadovaná oprávnění, ale neprovedou se žádná další kontrola oprávnění pro uživatele zadaného v této hodnotě. Používá se jenom pro SAS delegování uživatele.
protocol

Volitelný. Povolené protokoly HTTP.
resource

Volitelný. 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

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

Volitelný. Přístup ke službám úložiště (pouze pro SAS účtu) Další podrobnosti najdete v AccountSASServices.
signature

Podpis tokenu SAS.
startsOn

Volitelný. Čas zahájení 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 tokenu SAS

options
SASQueryParametersOptions

Volitelný. 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 tokenu SAS

permissions

string

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

services

string

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

Představuje rozsah platných IP adres pro tento token SAS.

identifier

string

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

resource

string

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

cacheControl

string

Reprezentace hlavičky ovládacího prvku mezipaměti (pouze pro SAS služby Blob/File Service)

contentDisposition

string

Reprezentace hlavičky 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

Reprezentace hlavičky jazyka obsahu (pouze pro SAS služby Blob/File Service)

contentType

string

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

userDelegationKey
UserDelegationKey

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

preauthorizedAgentObjectId

string

Představuje autorizované ID 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 délky obsahu v SAS služby Blob/File Service

contentLanguage?: string

Hodnota vlastnosti

string

contentType

Hodnota hlavičky typu obsahu v SAS služby Blob/File Service

contentType?: string

Hodnota vlastnosti

string

correlationId

Hodnota GUID, která se bude protokolovat 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 jenom pro SAS delegování uživatele.

correlationId?: string

Hodnota vlastnosti

string

encryptionScope

Volitelný. 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

Volitelný. 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

Volitelný. Povolený rozsah IP adres pro tento SAS.

undefined | SasIPRange ipRange

Hodnota vlastnosti

undefined | SasIPRange

permissions

Volitelné pouze v případě, že je zadaný identifikátor. Další podrobnosti najdete v AccountSASPermissions, BlobSASPermissionsnebo ContainerSASPermission s.

permissions?: string

Hodnota vlastnosti

string

preauthorizedAgentObjectId

Autorizované ID 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é SAS. Služba Azure Storage zajistí, že vlastník klíče delegování uživatele má před udělením přístupu požadovaná oprávnění, ale neprovedou se žádná další kontrola oprávnění pro uživatele zadaného v této hodnotě. Používá se jenom pro SAS delegování uživatele.

preauthorizedAgentObjectId?: string

Hodnota vlastnosti

string

protocol

Volitelný. Povolené protokoly HTTP.

protocol?: SASProtocol

Hodnota vlastnosti

SASProtocol

resource

Volitelný. 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

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

resourceTypes?: string

Hodnota vlastnosti

string

services

Volitelný. Přístup ke službám úložiště (pouze pro SAS účtu) Další podrobnosti najdete v AccountSASServices.

services?: string

Hodnota vlastnosti

string

signature

Podpis tokenu SAS.

signature: string

Hodnota vlastnosti

string

startsOn

Volitelný. Čas zahájení 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