Sdílet prostřednictvím

@azure/storage-queue package

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á účtem AccountSAS. Nastavení hodnoty true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole oprávnění u objektu <xref:AccountSASSignatureValues>. Řetězec oprávnění je možné vytvořit bez této třídy, ale pořadí oprávnění je specifické a tato třída zaručuje správnost.
AccountSASResourceTypes

K DISPOZICI POUZE V NODE.JS RUNTIME. Jedná se o pomocnou třídu pro vytvoření řetězce představujícího prostředky přístupné účtem AccountSAS. Nastavení hodnoty na hodnotu true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí přístup k danému typu prostředku. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole prostředků v objektu <xref:AccountSASSignatureValues>. Řetězec prostředků je možné sestavit bez této třídy, ale pořadí prostředků je specifické 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í služby přístupné účtem AccountSAS. Nastavení hodnoty true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí přístup k této službě. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole služeb v objektu <xref:AccountSASSignatureValues>. Řetězec služeb je možné sestavit bez této třídy, ale pořadí služeb je specifické a tato třída zaručuje správnost.
AnonymousCredential

AnonymousCredential poskytuje <xref:CredentialPolicyCreator> člen použitý k vytvoření <xref:AnonymousCredentialPolicy> objektů. <xref:AnonymousCredentialPolicy> se používá s požadavky HTTP(S), které čtou veřejné prostředky nebo se používají se sdílenými přístupovými podpisy (SAS).
AnonymousCredentialPolicy

AnonymousCredentialPolicy se používá s požadavky HTTP(S), které čtou veřejné prostředky nebo se používají se sdílenými přístupovými podpisy (SAS).
Credential

Přihlašovací údaje jsou abstraktní třídou 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 podepsání požadavků HTTP(S) před odesláním Toto je abstraktní třída.
Pipeline

Třída kanálu obsahující zásady požadavků HTTP. Výchozí kanál můžete vytvořit voláním newPipeline(). Nebo můžete vytvořit kanál s vlastními zásadami konstruktorem kanálu. Před implementací přizpůsobeného kanálu si přečtěte novépipeline() a poskytnuté zásady jako referenci.
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 true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole oprávnění u <xref:QueueSASSignatureValues> objektu. Řetězec oprávnění je možné vytvořit bez této třídy, ale pořadí oprávnění je specifické a tato třída zaručuje správnost.
QueueServiceClient

QueueServiceClient představuje adresu URL služby Azure Storage Queue, která umožňuje manipulovat s frontami.
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 <xref:AccountSASSignatureValues> a <xref:QueueSASSignatureValues>. Po vygenerování je možné ho zakódovat do <xref:String> 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é.
StorageBrowserPolicy

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

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

  2. Odebrání hlavičky cookie pro zabezpečení

  3. Odebrání záhlaví délky obsahu, aby se zabránilo upozornění prohlížečů
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory je třída továrny, která pomáhá generovat <xref:StorageBrowserPolicy> objekty.
StorageClient

StorageClient představuje základní třídu klienta pro <xref:QueueServiceClient>, <xref:QueueClient> atd.
StorageClientContext
StorageRetryPolicy

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

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

K DISPOZICI POUZE V NODE.JS RUNTIME. StorageSharedKeyCredential pro autorizaci klíče účtu služby Azure Storage
StorageSharedKeyCredentialPolicy

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

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 zde uvedené hodnoty správně nastaveny, volání generateSASQueryParameters() získat reprezentaci SAS, které lze skutečně použít na adresy URL fronty. Poznámka: Tato třída i <xref:SASQueryParameters> existují, protože první třída je proměnlivá a logická reprezentace, zatímco druhá třída je neměnná a používá se k vygenerování skutečných požadavků REST.
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í známé jako zásady stejného původu, které brání webové stránce v volání rozhraní API v jiné doméně; CORS poskytuje bezpečný způsob, jak umožnit jedné doméně (původní doméně) volat rozhraní API v jiné doméně.
DequeuedMessageItem

Objekt vrácený v poli QueueMessageList při volání Get Messages ve frontě.
EnqueuedMessage

Objekt vrácený v poli QueueMessageList při volání Put Message do fronty
GeoReplication

Geo-Replication informace o sekundární službě úložiště
ListQueuesSegmentResponse

Objekt vrácený při volání front seznamu ve službě Fronty.
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 operaci Messages_dequeue.
MessagesDequeueOptionalParams

Volitelné parametry.
MessagesEnqueueHeaders

Definuje hlavičky pro operaci Messages_enqueue.
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 zpráv ve frontě
PipelineOptions

Rozhraní option pro konstruktor kanálu.
QueueClearMessagesOptions

Možnosti konfigurace operace <xref:QueueClient.clearMessages>
QueueCreateHeaders

Definuje hlavičky pro operaci Queue_create.
QueueCreateIfNotExistsResponse

Obsahuje data odpovědí pro operaci <xref:QueueClient.createIfNotExists>.
QueueCreateOptions

Možnosti konfigurace operace <xref:QueueClient.create>
QueueDeleteHeaders

Definuje hlavičky pro operaci Queue_delete.
QueueDeleteIfExistsResponse

Obsahuje data odpovědí pro operaci <xref:QueueClient.deleteIfExists>.
QueueDeleteMessageOptions

Možnosti konfigurace operace <xref:QueueClient.deleteMessage>
QueueDeleteOptions

Možnosti konfigurace operace <xref:QueueClient.delete>
QueueExistsOptions

Možnosti konfigurace operace <xref:QueueClient.exists>
QueueGenerateSasUrlOptions

Možnosti konfigurace operace <xref:QueueClient.generateSasUrl>
QueueGetAccessPolicyHeaders

Definuje hlavičky pro operaci Queue_getAccessPolicy.
QueueGetAccessPolicyOptions

Možnosti konfigurace operace <xref:QueueClient.getAccessPolicy>
QueueGetPropertiesHeaders

Definuje hlavičky pro operaci Queue_getProperties.
QueueGetPropertiesOptions

Možnosti konfigurace operace <xref:QueueClient.getProperties>
QueueItem

Fronta služby Azure Storage.
QueuePeekMessagesOptions

Možnosti konfigurace operace <xref:QueueClient.peekMessages>
QueueReceiveMessageOptions

Možnosti konfigurace operace <xref:QueueClient.receiveMessages>
QueueSASSignatureValues

K DISPOZICI POUZE V NODE.JS RUNTIME. QueueSASSignatureValues slouží ke generování tokenů SAS služby Queue pro fronty.
QueueSendMessageOptions

Možnosti konfigurace operace <xref:QueueClient.sendMessage>
QueueServiceProperties

Vlastnosti služby úložiště.
QueueServiceStatistics

Statistiky pro službu úložiště
QueueSetAccessPolicyHeaders

Definuje hlavičky pro operaci Queue_setAccessPolicy.
QueueSetAccessPolicyOptions

Možnosti konfigurace operace <xref:QueueClient.setAccessPolicy>
QueueSetMetadataHeaders

Definuje hlavičky pro operaci Queue_setMetadata.
QueueSetMetadataOptions

Možnosti konfigurace operace <xref:QueueClient.setMetadata>
QueueUpdateMessageOptions

Možnosti konfigurace operace <xref:QueueClient.updateMessage>
RetentionPolicy

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

Povolený rozsah IP adres pro SAS.
ServiceGenerateAccountSasUrlOptions

Možnosti konfigurace operace <xref:QueueServiceClient.generateAccountSasUrl>
ServiceGetPropertiesHeaders

Definuje hlavičky pro operaci Service_getProperties.
ServiceGetPropertiesOptions

Možnosti konfigurace operace <xref:QueueServiceClient.getProperties>
ServiceGetStatisticsHeaders

Definuje hlavičky pro operaci Service_getStatistics.
ServiceGetStatisticsOptions

Možnosti konfigurace operace <xref:QueueServiceClient.getStatistics>
ServiceListQueuesOptions

Možnosti konfigurace operace <xref:QueueServiceClient.listQueues>
ServiceListQueuesSegmentHeaders

Definuje hlavičky pro operaci Service_listQueuesSegment.
ServiceSetPropertiesHeaders

Definuje hlavičky pro operaci Service_setProperties.
ServiceSetPropertiesOptions

Možnosti konfigurace operace <xref:QueueServiceClient.setProperties>
SignedIdentifier

Podepsaný identifikátor.
SignedIdentifierModel

podepsaný identifikátor
StorageClientOptionalParams

Volitelné parametry.
StoragePipelineOptions

Rozhraní možností pro metodu newPipeline().
StorageRetryOptions

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

Aliasy typu

CredentialPolicyCreator

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

Definuje hodnoty pro GeoReplicationStatusType.
ListQueuesIncludeType

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

Obsahuje data odpovědí pro operaci odstranění.
MessageIdUpdateResponse

Obsahuje data odpovědí pro operaci aktualizace.
MessagesClearResponse

Obsahuje data odpovědí pro jasnou operaci.
QueueClearMessagesResponse

Obsahuje data odpovědí pro operaci <xref:QueueClient.clearMessages>.
QueueCreateResponse

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

Obsahuje data odpovědí pro operaci <xref:QueueClient.deleteMessage>.
QueueDeleteResponse

Obsahuje data odpovědí pro operaci odstranění.
QueueGetAccessPolicyResponse

Obsahuje data odpovědí pro operaci <xref:QueueClient.getAccessPolicy>.
QueueGetPropertiesResponse

Obsahuje data odpovědí pro operaci getProperties.
QueuePeekMessagesResponse

Obsahuje data odpovědí pro operaci <xref:QueueClient.peekMessages>.
QueueReceiveMessageResponse

Obsahuje data odpovědí pro operaci <xref:QueueClient.receiveMessages>.
QueueSendMessageResponse

Obsahuje data odpovědí pro operaci <xref:QueueClient.sendMessage>.
QueueSetAccessPolicyResponse

Obsahuje data odpovědi pro operaci setAccessPolicy.
QueueSetMetadataResponse

Obsahuje data odpovědi pro operaci setMetadata.
QueueUpdateMessageResponse

Obsahuje data odpovědí pro operaci <xref:QueueClient.updateMessage>.
ReceivedMessageItem

Objekt vrácený v poli receivedMessageItems při volání <xref:QueueClient.receiveMessages>. Viz: <xref:QueueReceiveMessageResponse>
ServiceGetPropertiesResponse

Obsahuje data odpovědí 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.
StorageRetryPolicyType

Typy RetryPolicy.

Funkce

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME. Vygeneruje objekt <xref:SASQueryParameters>, který obsahuje všechny parametry dotazu SAS potřebné k provedení skutečného požadavku REST.
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME. Vytvoří instanci SASQueryParameters.

Přijímá pouze požadovaná nastavení potřebná k vytvoření sdíleného přístupového podpisu. Pro volitelná nastavení nastavte odpovídající vlastnosti přímo, například oprávnění, startOn a identifikátor.

UPOZORNĚNÍ: Pokud identifikátor není zadaný, jsou vyžadována oprávnění a vypršení platnosti. Pokud tento konstruktor inicializace inicializace pomocí tohoto konstruktoru inicialy, musíte k identifikátoru přiřadit hodnotu nebo platnost vyprší & oprávnění ručně.
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

Podrobnosti funkce

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME. Vygeneruje objekt <xref:SASQueryParameters>, který obsahuje všechny parametry dotazu SAS potřebné k provedení skutečného požadavku REST.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

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.

Přijímá pouze požadovaná nastavení potřebná k vytvoření sdíleného přístupového podpisu. Pro volitelná nastavení nastavte odpovídající vlastnosti přímo, například oprávnění, startOn a identifikátor.

UPOZORNĚNÍ: Pokud identifikátor není zadaný, jsou vyžadována oprávnění a vypršení platnosti. Pokud tento konstruktor inicializace inicializace pomocí tohoto konstruktoru inicialy, musíte k identifikátoru přiřadit hodnotu nebo platnost vyprší & oprávnění ručně.

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parametry

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Návraty

SASQueryParameters

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)

Parametry

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions
StoragePipelineOptions

Volby.

Návraty

Pipeline

Nový objekt kanálu.