@azure/storage-queue package

  • Reference

Třídy

AccountSASPermissions

K DISPOZICI POUZE V NODE.JS RUNTIME.

Toto je pomocná třída pro vytvoření řetězce představujícího oprávnění udělená AccountSAS. Nastavení hodnoty na true znamená, že každý SDÍLENÝ přístupový podpis, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován s toString a nastavit jako pole oprávnění v AccountSASSignatureValues objektu. Je možné vytvořit řetězec oprávnění bez této třídy, ale pořadí oprávnění je zvláštní a tato třída zaručuje správnost.
AccountSASResourceTypes

K DISPOZICI POUZE V NODE.JS RUNTIME.

Toto je pomocná třída pro vytvoření řetězce představujícího prostředky přístupné přes AccountSAS. Nastavení hodnoty na true znamená, že každý sdílený přístupový podpis, který tato oprávnění používá, udělí přístup k danému typu prostředku. Jakmile jsou všechny hodnoty nastaveny, by měla být serializována pomocí toString a nastavena jako pole prostředků accountSASSignatureValues objektu. Je možné vytvořit řetězec prostředků bez této třídy, ale pořadí prostředků je zvláštní a tato třída zaručuje správnost.
AccountSASServices

K DISPOZICI POUZE V NODE.JS RUNTIME.

Toto je pomocná třída pro vytvoření řetězce představujícího služby přístupné z AccountSAS. Nastavení hodnoty na true znamená, že každý sdílený přístupový podpis, který tato oprávnění používá, udělí přístup k této službě. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován s toString a nastaven jako services pole AccountSASSignatureValues objektu. Je možné vytvořit řetězec služeb bez této třídy, ale pořadí služeb je zvláštní a tato třída zaručuje správnost.
AnonymousCredential

AnonymousCredential poskytuje člen CredentialPolicyCreator sloužící k vytvoření objektů AnonymousCredentialPolicy . AnonymousCredentialPolicy se používá u požadavků HTTP(S), které čtou veřejné prostředky, nebo pro použití se sdílenými přístupovými podpisy (SAS).
AnonymousCredentialPolicy

AnonymousCredentialPolicy se používá u požadavků HTTP(S), které čtou veřejné prostředky, nebo pro použití se sdílenými přístupovými podpisy (SAS).
BaseRequestPolicy

Základní třída, ze které jsou odvozeny všechny zásady požadavků.
Credential

Credential je abstraktní třída pro podepisování požadavků HTTP služby Azure Storage. Tato třída bude hostitelem objektu pro vytváření přihlašovacích údajůPolicyCreator, který generuje CredentialPolicy.
CredentialPolicy

Zásady přihlašovacích údajů používané k podepisování požadavků HTTP(S) před odesláním. Toto je abstraktní třída.
HttpHeaders

Kolekce párů klíč/hodnota hlavičky HTTP.
Pipeline

Třída pipeline obsahující zásady požadavků HTTP. Výchozí kanál můžete vytvořit voláním metody newPipeline(). Nebo můžete vytvořit kanál s vlastními zásadami pomocí konstruktoru pipeline. Před implementací přizpůsobeného kanálu si jako referenci projděte newPipeline() a poskytnuté zásady.
QueueClient

QueueClient představuje adresu URL zpráv fronty služby Azure Storage, která umožňuje manipulovat s jejími zprávami.
QueueSASPermissions

K DISPOZICI POUZE V NODE.JS RUNTIME.

Toto je pomocná třída pro vytvoření řetězce představujícího oprávnění udělená službou ServiceSAS frontě. Nastavení hodnoty na true znamená, že každý SDÍLENÝ přístupový podpis, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován s toString a nastaven jako pole oprávnění QueueSASSignatureValues objektu. Je možné vytvořit řetězec oprávnění bez této třídy, ale pořadí oprávnění je zvláštní a tato třída zaručuje správnost.
QueueServiceClient

QueueServiceClient představuje adresu URL služby Azure Storage Queue Service, která umožňuje manipulaci s frontami.
RequestPolicyOptions

Volitelné vlastnosti, které lze použít při vytváření RequestPolicy.
RestError

Chyba vyplývající z požadavku HTTP na koncový bod služby.
SASQueryParameters

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 QueueSASSignatureValues . 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é.
StorageBrowserPolicy

StorageBrowserPolicy bude zpracovávat rozdíly mezi Node.js a modulem runtime prohlížeče, včetně následujících:

  1. Prohlížeče ukládají požadavky GET/HEAD do mezipaměti přidáním podmíněných hlaviček, například "IF_MODIFIED_SINCE". StorageBrowserPolicy je zásada, která se používá k přidání dotazu časového razítka do adresy URL požadavku GET/HEAD, čímž se vyhnete mezipaměti prohlížeče.

  2. Odebrání hlavičky souboru cookie z důvodu zabezpečení

  3. Odebrání hlavičky content-length, aby se zabránilo upozornění prohlížeče
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory je třída továrny, která pomáhá generovat objekty StorageBrowserPolicy .
StorageRetryPolicy

Zásady opakování s implementovanými exponenciálními a lineárními opakováními.
StorageRetryPolicyFactory

StorageRetryPolicyFactory je třída továrny, která pomáhá generovat objekty StorageRetryPolicy .
StorageSharedKeyCredential

K DISPOZICI POUZE V NODE.JS RUNTIME.

StorageSharedKeyCredential pro autorizaci klíče účtu služby Azure Storage.
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy je zásada používaná k podepsání požadavku HTTP pomocí sdíleného klíče.
WebResource

Vytvoří nový WebResource objekt.

Tato třída poskytuje abstrakci volání REST tím, že je nezávislá na knihovně nebo implementaci a zabalení potřebných vlastností k zahájení požadavku.

Rozhraní

AccessPolicy

Zásady přístupu
AccountSASSignatureValues

K DISPOZICI POUZE V NODE.JS RUNTIME.

AccountSASSignatureValues slouží k vygenerování sdíleného přístupového podpisu (SAS) pro účet služby Azure Storage. Jakmile jsou všechny hodnoty správně nastaveny, zavolejte metodu generateSASQueryParameters() a získejte reprezentaci SAS, která se dá ve skutečnosti použít na adresy URL fronty. Poznámka: Tato třída i SASQueryParameters existují, protože první třída je proměnlivá a logická reprezentace, zatímco druhá je neměnná a používá se ke generování skutečných požadavků REST.

Další https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 koncepční informace o SAS najdete v tématu https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas Popis parametrů, včetně požadovaných parametrů.
CommonOptions

Rozhraní pro možnosti společné pro každou vzdálenou operaci.
CorsRule

CORS je funkce HTTP, která umožňuje webové aplikaci spuštěné v jedné doméně přistupovat k prostředkům v jiné doméně. Webové prohlížeče implementují omezení zabezpečení označované jako zásady stejného původu, které brání webové stránce volat rozhraní API v jiné doméně. CORS poskytuje bezpečný způsob, jak jedné doméně (původní doméně) povolit volání rozhraní API v jiné doméně.
DequeuedMessageItem

Objekt vrácený v poli QueueMessageList při volání metody Get Messages on a Queue.
EnqueuedMessage

Objekt vrácený v poli QueueMessageList při volání metody Put Message on a Queue
GeoReplication

Geo-Replication informace pro sekundární službu úložiště
HttpOperationResponse

Objekt Wrapper pro požadavek HTTP a odpověď. Deserializovaný objekt se při přijetí textu odpovědi ve formátu JSON nebo XML uloží do parsedBody vlastnosti .
IHttpClient

Rozhraní, které může odesílat httpRequests a přijímat slibované HttpResponses.
ListQueuesSegmentResponse

Objekt vrácený při volání front seznamu ve službě front.
Logging

Nastavení protokolování Azure Analytics.
MessageIdDeleteHeaders

Definuje hlavičky pro operaci MessageId_delete.
MessageIdUpdateHeaders

Definuje hlavičky pro operaci MessageId_update.
MessagesClearHeaders

Definuje hlavičky pro operaci Messages_clear.
MessagesDequeueHeaders

Definuje hlavičky pro Messages_dequeue operaci.
MessagesDequeueOptionalParams

Volitelné parametry.
MessagesEnqueueHeaders

Definuje hlavičky pro Messages_enqueue operaci.
MessagesEnqueueOptionalParams

Volitelné parametry.
MessagesPeekHeaders

Definuje hlavičky pro operaci Messages_peek.
MessagesPeekOptionalParams

Volitelné parametry.
Metadata

Kolekce párů řetězců klíč-hodnota.
Metrics

Rozhraní představující metriky.
PeekedMessageItem

Objekt vrácený v poli QueueMessageList při volání Náhled Messages ve frontě
PipelineOptions

Rozhraní option pro konstruktor kanálu.
QueueClearMessagesOptions

Možnosti konfigurace operace clearMessages
QueueCreateHeaders

Definuje hlavičky pro operaci Queue_create.
QueueCreateIfNotExistsResponse

Obsahuje data odpovědi pro operaci createIfNotExists .
QueueCreateOptions

Možnosti konfigurace operace vytvoření
QueueDeleteHeaders

Definuje hlavičky pro Queue_delete operaci.
QueueDeleteIfExistsResponse

Obsahuje data odpovědi pro operaci deleteIfExists .
QueueDeleteMessageOptions

Možnosti konfigurace operace deleteMessage
QueueDeleteOptions

Možnosti konfigurace operace odstranění
QueueExistsOptions

Možnosti konfigurace operace existuje
QueueGenerateSasUrlOptions

Možnosti konfigurace operace generateSasUrl
QueueGetAccessPolicyHeaders

Definuje hlavičky pro operaci Queue_getAccessPolicy.
QueueGetAccessPolicyOptions

Možnosti konfigurace operace getAccessPolicy
QueueGetPropertiesHeaders

Definuje hlavičky pro Queue_getProperties operaci.
QueueGetPropertiesOptions

Možnosti konfigurace operace getProperties
QueueItem

Fronta Azure Storage.
QueuePeekMessagesOptions

Možnosti konfigurace operace peekMessages
QueueReceiveMessageOptions

Možnosti konfigurace operace receiveMessages
QueueSASSignatureValues

K DISPOZICI POUZE V NODE.JS RUNTIME.

QueueSASSignatureValues slouží k vygenerování tokenů SAS služby Queue Pro fronty.
QueueSendMessageOptions

Možnosti konfigurace operace sendMessage
QueueServiceProperties

Vlastnosti služby Storage.
QueueServiceStatistics

Statistiky služby úložiště
QueueSetAccessPolicyHeaders

Definuje hlavičky pro operaci Queue_setAccessPolicy.
QueueSetAccessPolicyOptions

Možnosti konfigurace operace setAccessPolicy
QueueSetMetadataHeaders

Definuje hlavičky pro operaci Queue_setMetadata.
QueueSetMetadataOptions

Možnosti konfigurace operace setMetadata
QueueUpdateMessageOptions

Možnosti konfigurace operace updateMessage
RequestPolicy

Základní struktura zásad požadavků.
RetentionPolicy

zásady uchovávání informací
SasIPRange

Povolený rozsah IP adres pro SAS
ServiceGenerateAccountSasUrlOptions

Možnosti konfigurace operace generateAccountSasUrl
ServiceGetPropertiesHeaders

Definuje hlavičky pro operaci Service_getProperties.
ServiceGetPropertiesOptions

Možnosti konfigurace operace getProperties
ServiceGetStatisticsHeaders

Definuje hlavičky pro operaci Service_getStatistics.
ServiceGetStatisticsOptions

Možnosti konfigurace operace getStatistics
ServiceListQueuesOptions

Možnosti konfigurace operace listQueues
ServiceListQueuesSegmentHeaders

Definuje hlavičky pro Service_listQueuesSegment operaci.
ServiceSetPropertiesHeaders

Definuje hlavičky pro Service_setProperties operaci.
ServiceSetPropertiesOptions

Možnosti konfigurace operace setProperties
SignedIdentifier

Podepsaný identifikátor.
SignedIdentifierModel

podepsaný identifikátor
StoragePipelineOptions

Rozhraní option pro metodu newPipeline().
StorageRetryOptions

Rozhraní možností opakování ve frontě úložiště

Aliasy typu

CredentialPolicyCreator

Funkce továrny, která vytvoří novou zásadu CredentialPolicy, která používá zadanou zásadu nextPolicy.
GeoReplicationStatusType

Definuje hodnoty pro GeoReplicationStatusType.
HttpRequestBody

Možné typy textu požadavku HTTP
ListQueuesIncludeType

Definuje hodnoty pro ListQueuesIncludeType. Mezi možné hodnoty patří metadata.
MessageIdDeleteResponse

Obsahuje data odpovědi na operaci odstranění.
MessageIdUpdateResponse

Obsahuje data odpovědi na operaci aktualizace.
MessagesClearResponse

Obsahuje data odpovědi pro operaci vymazání.
QueueClearMessagesResponse

Obsahuje data odpovědi pro operaci clearMessages .
QueueCreateResponse

Obsahuje data odpovědi pro operaci vytvoření.
QueueDeleteMessageResponse

Obsahuje data odpovědi pro operaci deleteMessage .
QueueDeleteResponse

Obsahuje data odpovědi na operaci odstranění.
QueueGetAccessPolicyResponse

Obsahuje data odpovědi pro operaci getAccessPolicy .
QueueGetPropertiesResponse

Obsahuje data odpovědi pro operaci getProperties.
QueuePeekMessagesResponse

Obsahuje data odpovědi pro operaci peekMessages .
QueueReceiveMessageResponse

Obsahuje data odpovědi pro operaci receiveMessages .
QueueSendMessageResponse

Obsahuje data odpovědi pro operaci sendMessage .
QueueSetAccessPolicyResponse

Obsahuje data odpovědi pro operaci setAccessPolicy.
QueueSetMetadataResponse

Obsahuje data odpovědi pro operaci setMetadata.
QueueUpdateMessageResponse

Obsahuje data odpovědi pro operaci updateMessage .
ReceivedMessageItem

Objekt vrácený receivedMessageItems v poli při volání receiveMessages.

Viz : QueueReceiveMessageResponse
RequestPolicyFactory

Vytvoří novou zásadu RequestPolicy pro každou žádost, která používá zadanou zásadu nextPolicy.
ServiceGetPropertiesResponse

Obsahuje data odpovědi pro operaci getProperties.
ServiceGetStatisticsResponse

Obsahuje data odpovědi pro operaci getStatistics.
ServiceListQueuesSegmentResponse

Obsahuje data odpovědi pro operaci listQueuesSegment.
ServiceSetPropertiesResponse

Obsahuje data odpovědi pro operaci setProperties.

Výčty

SASProtocol

Protokoly pro vygenerovaný SAS.
StorageQueueAudience

Definuje známé cílové skupiny cloudu pro službu Storage.
StorageRetryPolicyType

Typy RetryPolicy.

Funkce

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Vytvořte novou serializaci RequestPolicyCreator, která bude serializovat těla požadavků HTTP při průchodu kanálem HTTP.
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Vygeneruje OBJEKT SASQueryParameters , který obsahuje všechny parametry dotazu SAS potřebné k provedení skutečného požadavku REST.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas.
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Vytvoří instanci SASQueryParameters.

Akceptuje jenom požadovaná nastavení potřebná k vytvoření SAS. V případě volitelných nastavení nastavte přímo odpovídající vlastnosti, jako jsou oprávnění, startOn a identifikátor.

UPOZORNĚNÍ: Pokud identifikátor není zadaný, vyžadují se oprávnění a expiresOn. Musíte přiřadit hodnotu identifikátoru nebo vypršení platnostiU & oprávnění ručně, pokud iniciacializace pomocí tohoto konstruktoru.
getQueueServiceAccountAudience(string)
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Vytvoří nový objekt kanálu se zadanými přihlašovacími údaji.

Podrobnosti funkce

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Vytvořte novou serializaci RequestPolicyCreator, která bude serializovat těla požadavků HTTP při průchodu kanálem HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Parametry

deserializationContentTypes
DeserializationContentTypes
parsingOptions
SerializerOptions

Návraty

RequestPolicyFactory

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Vygeneruje OBJEKT SASQueryParameters , který obsahuje všechny parametry dotazu SAS potřebné k provedení skutečného požadavku REST.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parametry

accountSASSignatureValues
AccountSASSignatureValues

Hodnoty podpisu SAS účtu

sharedKeyCredential
StorageSharedKeyCredential

Přihlašovací údaje sdíleného klíče.

Návraty

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Vytvoří instanci SASQueryParameters.

Akceptuje jenom požadovaná nastavení potřebná k vytvoření SAS. V případě volitelných nastavení nastavte přímo odpovídající vlastnosti, jako jsou oprávnění, startOn a identifikátor.

UPOZORNĚNÍ: Pokud identifikátor není zadaný, vyžadují se oprávnění a expiresOn. Musíte přiřadit hodnotu identifikátoru nebo vypršení platnostiU & oprávnění ručně, pokud iniciacializace pomocí tohoto konstruktoru.

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parametry

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Návraty

SASQueryParameters

getQueueServiceAccountAudience(string) 

function getQueueServiceAccountAudience(storageAccountName: string): string

Parametry

storageAccountName

string

Návraty

string

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Vytvoří nový objekt kanálu se zadanými přihlašovacími údaji.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Parametry

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověření požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadaný, použije se AnonymousCredential.

pipelineOptions
StoragePipelineOptions

Možnosti.

Návraty

Pipeline

Nový objekt kanálu.