@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ěl by být serializován s toString a nastaven jako pole oprávnění v AccountSASSignatureValues 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.
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ěl by být serializován s toString a nastaven jako pole zdroje v AccountSASSignatureValues objektu. Ř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 AccountSASSignatureValues objektu. Ř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 člen credentialPolicyCreator sloužící k vytvoření AnonymousCredentialPolicy objekty. 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).
BaseRequestPolicy	Základní třída, ze které jsou odvozeny všechny zásady požadavků.
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 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 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í na 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 pouze AccountSASSignatureValues a QueueSASSignatureValues typy. 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é.
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory je třída továrny, která pomáhá generovat objekty StorageBrowserPolicy.
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 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 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. Další koncepční informace o SAS najdete v https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1, kde najdete https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas popisy 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í 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ě
HttpHeaders	Kolekce párů klíč/hodnota hlavičky HTTP.
HttpOperationResponse	Odpověď HTTP, která je kompatibilní s jádrem-v1 (core-http).
HttpResponse	Reprezentace odpovědi HTTP, která obsahuje odkaz na požadavek, který ho pochází.
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ě
PipelineLike	Rozhraní pro třídu pipeline Pipeline 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 newPipeline a poskytnuté zásady.
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ědí pro operaci createIfNotExists.
QueueCreateOptions	Možnosti konfigurace operace vytvoření
QueueDeleteHeaders	Definuje hlavičky pro operaci Queue_delete.
QueueDeleteIfExistsResponse	Obsahuje data odpovědí pro operaci deleteIfExists.
QueueDeleteMessageOptions	Možnosti konfigurace operace deleteMessage
QueueDeleteOptions	Možnosti konfigurace operace odstranění
QueueExistsOptions	Možnosti konfigurace existují operace
QueueGenerateSasUrlOptions	Možnosti konfigurace vygenerování operace SasUrl
QueueGetAccessPolicyHeaders	Definuje hlavičky pro operaci Queue_getAccessPolicy.
QueueGetAccessPolicyOptions	Možnosti konfigurace operace getAccessPolicy
QueueGetPropertiesHeaders	Definuje hlavičky pro operaci Queue_getProperties.
QueueGetPropertiesOptions	Možnosti konfigurace operace getProperties
QueueItem	Fronta služby Azure Storage.
QueuePeekMessagesOptions	Možnosti konfigurace operace peekMessages
QueueReceiveMessageOptions	Možnosti konfigurace operace 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 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 setAccessPolicy
QueueSetMetadataHeaders	Definuje hlavičky pro operaci Queue_setMetadata.
QueueSetMetadataOptions	Možnosti konfigurace operace setMetadata
QueueUpdateMessageOptions	Možnosti konfigurace operace updateMessage
RequestPolicy	Kompatibilní rozhraní pro zásady požadavků core-http
RequestPolicyFactory	Rozhraní pro kompatibilitu s RequestPolicyFactory core-http
RequestPolicyOptions	Rozhraní pro kompatibilitu s RequestPolicy
ResponseLike	Objekt s jednoduchou vlastností _response.
ResponseWithBody	Objekt s vlastností _response, která obsahuje tělo a záhlaví již parsovaná do známých typů.
ResponseWithHeaders	Objekt s vlastností _response, která obsahuje hlavičky, které jsou již analyzovány do zadaného objektu.
RestError	Vlastní typ chyby pro neúspěšné požadavky kanálu.
RetentionPolicy	zásady uchovávání informací
SasIPRange	Povolený rozsah IP adres pro SAS.
ServiceClientOptions	Podmnožina @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Možnosti konfigurace generateAccountSasUrl operace
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 operaci Service_listQueuesSegment.
ServiceSetPropertiesHeaders	Definuje hlavičky pro operaci Service_setProperties.
ServiceSetPropertiesOptions	Možnosti konfigurace operace setProperties
SignedIdentifier	Identifikátor se znaménkem.
SignedIdentifierModel	identifikátor se znaménkem
StoragePipelineOptions	Rozhraní Options pro funkci newPipeline
StorageRetryOptions	Rozhraní možností opakování objektu blob úložiště
WebResource	Popis požadavku HTTP, který se má provést na vzdálený server.

Aliasy typu

GeoReplicationStatusType	Definuje hodnoty pro GeoReplicationStatusType.
HttpRequestBody	Typy subjektů podporovaných na žádosti. NodeJS.ReadableStream a () => NodeJS.ReadableStream je pouze Uzel. Blob, ReadableStream<Uint8Array> a () => ReadableStream<Uint8Array> jsou pouze prohlížeče.
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 clearMessages.
QueueCreateResponse	Obsahuje data odpovědí pro operaci vytvoření.
QueueDeleteMessageResponse	Obsahuje data odpovědí pro operaci deleteMessage.
QueueDeleteResponse	Obsahuje data odpovědí pro operaci odstranění.
QueueGetAccessPolicyResponse	Obsahuje data odpovědí pro operaci getAccessPolicy.
QueueGetPropertiesResponse	Obsahuje data odpovědí pro operaci getProperties.
QueuePeekMessagesResponse	Obsahuje data odpovědi pro operaci peekMessages.
QueueReceiveMessageResponse	Obsahuje data odpovědi pro receiveMessages operace.
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ý v poli receivedMessageItems při volání receiveMessages. Viz: 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.
WithResponse	Typ, který představuje výsledek operace se známou vlastností _response.

Výčty

SASProtocol	Protokoly pro vygenerovaný SAS.
StorageQueueAudience	Definuje známé cílové skupiny cloudu pro službu Storage.
StorageRetryPolicyType	Typy RetryPolicy.

Funkce

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	K DISPOZICI POUZE V NODE.JS RUNTIME. Vygeneruje SASQueryParameters objekt, který obsahuje všechny parametry dotazu SAS potřebné k vytvoření skutečného požadavku REST. Viz https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
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ě.
getQueueServiceAccountAudience(string)	Pokud chcete získat cílovou skupinu OAuth pro účet úložiště pro službu queue.
isPipelineLike(unknown)	Pomocná rutina, která rozhodne, jestli daný argument splňuje kontrakt kanálu
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 SASQueryParameters objekt, který obsahuje všechny parametry dotazu SAS potřebné k vytvoření skutečného požadavku REST.

Viz https://learn.microsoft.com/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.

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): SASQueryParameters

Parametry

queueSASSignatureValues

QueueSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

Návraty

SASQueryParameters

getQueueServiceAccountAudience(string)

Pokud chcete získat cílovou skupinu OAuth pro účet úložiště pro službu queue.

function getQueueServiceAccountAudience(storageAccountName: string): string

Parametry

storageAccountName

string

Návraty

string

isPipelineLike(unknown)

Pomocná rutina, která rozhodne, jestli daný argument splňuje kontrakt kanálu

function isPipelineLike(pipeline: unknown): pipeline

Parametry

pipeline

unknown

Argument, který může být kanálem

Návraty

pipeline

true, pokud argument splňuje kontrakt kanálu

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 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

Optional. Options.

Návraty

Pipeline

Nový objekt kanálu.