@azure/storage-queue package

Klasser

AccountSASPermissions	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att skapa en sträng som representerar de behörigheter som beviljas av en AccountSAS. Om du anger ett värde till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för den åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfält för ett AccountSASSignatureValues-objekt . Det går att skapa behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet.
AccountSASResourceTypes	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att skapa en sträng som representerar de resurser som är tillgängliga för en AccountSAS. Om du anger värdet true innebär det att alla SAS som använder dessa behörigheter ger åtkomst till den resurstypen. När alla värden har angetts ska detta serialiseras med toString och anges som resursfält i ett AccountSASSignatureValues-objekt . Det går att skapa resurssträngen utan den här klassen, men resursordningen är speciell och den här klassen garanterar korrekthet.
AccountSASServices	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att skapa en sträng som representerar de tjänster som är tillgängliga för en AccountSAS. Om du anger ett värde till true innebär det att alla SAS som använder dessa behörigheter ger åtkomst till tjänsten. När alla värden har angetts ska detta serialiseras med toString och anges som tjänstfält i ett AccountSASSignatureValues-objekt . Det går att konstruera tjänststrängen utan den här klassen, men ordningen på tjänsterna är speciell och den här klassen garanterar korrekthet.
AnonymousCredential	AnonymousCredential tillhandahåller en credentialPolicyCreator-medlem som används för att skapa AnonymousCredentialPolicy-objekt. AnonymousCredentialPolicy används med HTTP(S)-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS).
AnonymousCredentialPolicy	AnonymousCredentialPolicy används med HTTP(S)-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS).
BaseRequestPolicy	Basklassen från vilken alla begärandeprinciper härleds.
Credential	Autentiseringsuppgifter är en abstrakt klass för signering av HTTP-begäranden i Azure Storage. Den här klassen är värd för en credentialPolicyCreator-fabrik som genererar CredentialPolicy.
CredentialPolicy	Princip för autentiseringsuppgifter som används för att signera HTTP(S)-begäranden innan de skickas. Det här är en abstrakt klass.
Pipeline	En Pipeline-klass som innehåller HTTP-begärandeprinciper. Du kan skapa en standardpipeline genom att anropa newPipeline. Eller så kan du skapa en pipeline med dina egna principer av konstruktorn för Pipeline. Läs nyaPipeline och tillhandahållna principer innan du implementerar din anpassade pipeline.
QueueClient	En QueueClient representerar en URL till en Azure Storage Queue-meddelanden så att du kan ändra dess meddelanden.
QueueSASPermissions	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att skapa en sträng som representerar de behörigheter som beviljas av en ServiceSAS till en kö. Om du anger ett värde till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för den åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet i ett QueueSASSignatureValues-objekt . Det går att skapa behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet.
QueueServiceClient	En QueueServiceClient representerar en URL till Azure Storage Queue-tjänsten så att du kan ändra köer.
RestError	En anpassad feltyp för misslyckade pipelinebegäranden.
SASQueryParameters	Representerar de komponenter som utgör en Azure Storage SAS-frågeparametrar. Den här typen skapas inte direkt av användaren. den genereras endast av typerna AccountSASSignatureValues och QueueSASSignatureValues . När den har genererats kan den kodas till en toString() och läggas till i en URL direkt (även om försiktighet bör vidtas här om det finns befintliga frågeparametrar, vilket kan påverka lämpliga sätt att lägga till dessa frågeparametrar). Obs! Instanser av den här klassen är oföränderliga.
StorageBrowserPolicy	StorageBrowserPolicy hanterar skillnader mellan Node.js och webbläsarkörning, inklusive: Webbläsare cachelagrar GET/HEAD-begäranden genom att lägga till villkorsstyrda rubriker som "IF_MODIFIED_SINCE". StorageBrowserPolicy är en princip som används för att lägga till en tidsstämpelfråga i URL:en för GET/HEAD-begäran och därmed undvika webbläsarens cacheminne. Ta bort cookie-rubrik för säkerhet Ta bort rubrik för innehållslängd för att undvika webbläsarvarning
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory är en fabriksklass som hjälper till att generera StorageBrowserPolicy-objekt.
StorageRetryPolicy	Återförsöksprincip med exponentiellt återförsök och linjärt återförsök implementerat.
StorageRetryPolicyFactory	StorageRetryPolicyFactory är en fabriksklass som hjälper till att generera StorageRetryPolicy-objekt .
StorageSharedKeyCredential	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. StorageSharedKeyCredential för kontonyckelauktorisering av Azure Storage-tjänsten.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy är en princip som används för att signera HTTP-begäran med en delad nyckel.

Gränssnitt

AccessPolicy	En åtkomstprincip
AccountSASSignatureValues	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. AccountSASSignatureValues används för att generera en signatur för delad åtkomst (SAS) för ett Azure Storage-konto. När alla värden här har angetts korrekt anropar du generateSASQueryParameters() för att hämta en representation av SAS som faktiskt kan tillämpas på kö-URL:er. Obs! Det finns både den här klassen och SASQueryParameters eftersom den förra är föränderlig och en logisk representation medan den senare är oföränderlig och används för att generera faktiska REST-begäranden. Mer https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 konceptuell information om SAS finns https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas i beskrivningar av parametrarna, inklusive vilka som krävs
CommonOptions	Ett gränssnitt för alternativ som är gemensamma för varje fjärråtgärd.
CorsRule	CORS är en HTTP-funktion som gör det möjligt för ett webbprogram som körs i en domän att komma åt resurser i en annan domän. Webbläsare implementerar en säkerhetsbegränsning som kallas principen för samma ursprung som förhindrar att en webbsida anropar API:er i en annan domän. CORS är ett säkert sätt att tillåta att en domän (ursprungsdomänen) anropar API:er i en annan domän
DequeuedMessageItem	Objektet som returneras i matrisen QueueMessageList när du anropar Hämta meddelanden i en kö.
EnqueuedMessage	Objektet som returneras i matrisen QueueMessageList när du anropar Placera meddelande i en kö
GeoReplication	Geo-Replication information för den sekundära lagringstjänsten
HttpHeaders	En samling http-huvudnyckel/värde-par.
HttpOperationResponse	Http-svar som är kompatibelt med core-v1(core-http).
HttpResponse	En representation av ett HTTP-svar som innehåller en referens till den begäran som kom från den.
IHttpClient	Ett kompatibelt gränssnitt för core-http-begärandeprinciper
ListQueuesSegmentResponse	Objektet returnerades när listköer anropades i en kötjänst.
Logging	Loggningsinställningar för Azure Analytics.
MessageIdDeleteHeaders	Definierar rubriker för MessageId_delete åtgärd.
MessageIdUpdateHeaders	Definierar rubriker för MessageId_update åtgärd.
MessagesClearHeaders	Definierar rubriker för Messages_clear åtgärd.
MessagesDequeueHeaders	Definierar rubriker för Messages_dequeue åtgärd.
MessagesDequeueOptionalParams	Valfria parametrar.
MessagesEnqueueHeaders	Definierar rubriker för Messages_enqueue åtgärd.
MessagesEnqueueOptionalParams	Valfria parametrar.
MessagesPeekHeaders	Definierar rubriker för Messages_peek åtgärd.
MessagesPeekOptionalParams	Valfria parametrar.
Metadata	En samling nyckel/värde-strängpar.
Metrics	Ett gränssnitt som representerar mått.
PeekedMessageItem	Objektet som returneras i matrisen QueueMessageList när du anropar Peek Messages i en kö
PipelineLike	Ett gränssnitt för pipelineklassen som innehåller HTTP-begärandeprinciper. Du kan skapa en standardpipeline genom att anropa newPipeline. Eller så kan du skapa en pipeline med dina egna principer av konstruktorn för Pipeline. Läs nyaPipeline och tillhandahållna principer innan du implementerar din anpassade pipeline.
PipelineOptions	Alternativgränssnitt för pipelinekonstruktor.
QueueClearMessagesOptions	Alternativ för att konfigurera clearMessages-åtgärden
QueueCreateHeaders	Definierar rubriker för Queue_create åtgärd.
QueueCreateIfNotExistsResponse	Innehåller svarsdata för åtgärden createIfNotExists .
QueueCreateOptions	Alternativ för att konfigurera skapandeåtgärd
QueueDeleteHeaders	Definierar rubriker för Queue_delete åtgärd.
QueueDeleteIfExistsResponse	Innehåller svarsdata för åtgärden deleteIfExists .
QueueDeleteMessageOptions	Alternativ för att konfigurera åtgärden deleteMessage
QueueDeleteOptions	Alternativ för att konfigurera borttagningsåtgärd
QueueExistsOptions	Alternativ för att konfigurera finns åtgärd
QueueGenerateSasUrlOptions	Alternativ för att konfigurera åtgärden generateSasUrl .
QueueGetAccessPolicyHeaders	Definierar rubriker för Queue_getAccessPolicy åtgärd.
QueueGetAccessPolicyOptions	Alternativ för att konfigurera getAccessPolicy-åtgärd
QueueGetPropertiesHeaders	Definierar rubriker för Queue_getProperties åtgärd.
QueueGetPropertiesOptions	Alternativ för att konfigurera åtgärden getProperties
QueueItem	En Azure Storage-kö.
QueuePeekMessagesOptions	Alternativ för att konfigurera peekMessages-åtgärden
QueueReceiveMessageOptions	Alternativ för att konfigurera åtgärden receiveMessages
QueueSASSignatureValues	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. QueueSASSignatureValues används för att generera SAS-token för köer i köer i köer.
QueueSendMessageOptions	Alternativ för att konfigurera åtgärden sendMessage
QueueServiceProperties	Egenskaper för lagringstjänsten.
QueueServiceStatistics	Statistik för lagringstjänsten.
QueueSetAccessPolicyHeaders	Definierar rubriker för Queue_setAccessPolicy åtgärd.
QueueSetAccessPolicyOptions	Alternativ för att konfigurera setAccessPolicy-åtgärd
QueueSetMetadataHeaders	Definierar rubriker för Queue_setMetadata åtgärd.
QueueSetMetadataOptions	Alternativ för att konfigurera setMetadata-åtgärd
QueueUpdateMessageOptions	Alternativ för att konfigurera updateMessage-åtgärd
RequestPolicyFactory	Ett gränssnitt för kompatibilitet med Core-http:s RequestPolicyFactory
RequestPolicyOptions	Ett gränssnitt för kompatibilitet med RequestPolicy
ResponseLike	Ett objekt med en enkel egenskap _response.
ResponseWithBody	Ett objekt med en _response-egenskap som redan har brödtext och rubriker parsade i kända typer.
ResponseWithHeaders	Ett objekt med en _response egenskap som redan har rubriker som redan parsats till ett skrivet objekt.
RetentionPolicy	kvarhållningsprincipen
SasIPRange	Tillåtet IP-intervall för en SAS.
ServiceClientOptions	En delmängd av @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Alternativ för att konfigurera åtgärden generateAccountSasUrl .
ServiceGetPropertiesHeaders	Definierar rubriker för Service_getProperties åtgärd.
ServiceGetPropertiesOptions	Alternativ för att konfigurera åtgärden getProperties
ServiceGetStatisticsHeaders	Definierar rubriker för Service_getStatistics åtgärd.
ServiceGetStatisticsOptions	Alternativ för att konfigurera getStatistics-åtgärd
ServiceListQueuesOptions	Alternativ för att konfigurera listQueues-åtgärd
ServiceListQueuesSegmentHeaders	Definierar rubriker för Service_listQueuesSegment åtgärd.
ServiceSetPropertiesHeaders	Definierar rubriker för Service_setProperties åtgärd.
ServiceSetPropertiesOptions	Alternativ för att konfigurera setProperties-åtgärd
SignedIdentifier	Signerad identifierare.
SignedIdentifierModel	signerad identifierare
StoragePipelineOptions	Alternativgränssnitt för funktionen newPipeline .
StorageRetryOptions	Gränssnitt för alternativ för återförsök av lagringsblob.
WebResource	En beskrivning av en HTTP-begäran som ska göras till en fjärrserver.

Typalias

CredentialPolicyCreator	En fabriksfunktion som skapar en ny CredentialPolicy som använder den angivna nextPolicy.
GeoReplicationStatusType	Definierar värden för GeoReplicationStatusType.
HttpRequestBody	Typer av organ som stöds i begäran. NodeJS.ReadableStream och () => NodeJS.ReadableStream är endast Node. Blob, ReadableStream och () => ReadableStream är endast webbläsare.
ListQueuesIncludeType	Definierar värden för ListQueuesIncludeType. Möjliga värden är: "metadata"
MessageIdDeleteResponse	Innehåller svarsdata för borttagningsåtgärden.
MessageIdUpdateResponse	Innehåller svarsdata för uppdateringsåtgärden.
MessagesClearResponse	Innehåller svarsdata för clear-åtgärden.
QueueClearMessagesResponse	Innehåller svarsdata för åtgärden clearMessages .
QueueCreateResponse	Innehåller svarsdata för skapandeåtgärden.
QueueDeleteMessageResponse	Innehåller svarsdata för åtgärden deleteMessage .
QueueDeleteResponse	Innehåller svarsdata för borttagningsåtgärden.
QueueGetAccessPolicyResponse	Innehåller svarsdata för åtgärden getAccessPolicy .
QueueGetPropertiesResponse	Innehåller svarsdata för åtgärden getProperties.
QueuePeekMessagesResponse	Innehåller svarsdata för åtgärden peekMessages .
QueueReceiveMessageResponse	Innehåller svarsdata för åtgärden receiveMessages .
QueueSendMessageResponse	Innehåller svarsdata för åtgärden sendMessage .
QueueSetAccessPolicyResponse	Innehåller svarsdata för setAccessPolicy-åtgärden.
QueueSetMetadataResponse	Innehåller svarsdata för setMetadata-åtgärden.
QueueUpdateMessageResponse	Innehåller svarsdata för åtgärden updateMessage .
ReceivedMessageItem	Objektet som returnerades i matrisen receivedMessageItems när det anropade receiveMessages. Se: QueueReceiveMessageResponse
ServiceGetPropertiesResponse	Innehåller svarsdata för åtgärden getProperties.
ServiceGetStatisticsResponse	Innehåller svarsdata för getStatistics-åtgärden.
ServiceListQueuesSegmentResponse	Innehåller svarsdata för åtgärden listQueuesSegment.
ServiceSetPropertiesResponse	Innehåller svarsdata för setProperties-åtgärden.
WithResponse	En typ som representerar ett åtgärdsresultat med en känd _response egenskap.

Uppräkningar

SASProtocol	Protokoll för genererad SAS.
StorageQueueAudience	Definierar kända molnmålgrupper för Storage.
StorageRetryPolicyType	RetryPolicy-typer.

Funktioner

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Genererar ett SASQueryParameters-objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran. Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en instans av SASQueryParameters. Accepterar endast nödvändiga inställningar som krävs för att skapa en SAS. För valfria inställningar anger du motsvarande egenskaper direkt, till exempel behörigheter, startsOn och identifierare. VARNING! När identifieraren inte har angetts krävs behörigheter och expiresOn. Du MÅSTE tilldela värdet till identifieraren eller förfallerPå & behörigheter manuellt om du börjar med den här konstruktorn.
getQueueServiceAccountAudience(string)	Så här hämtar du OAuth-målgruppen för ett lagringskonto för kötjänsten.
isPipelineLike(unknown)	En hjälpare som bestämmer om ett visst argument uppfyller pipelinekontraktet
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Skapar ett nytt Pipeline-objekt med tillhandahållna autentiseringsuppgifter.

Funktionsinformation

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Genererar ett SASQueryParameters-objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran.

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

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

Parametrar

accountSASSignatureValues

AccountSASSignatureValues

SAS-signaturvärden för kontot

sharedKeyCredential

StorageSharedKeyCredential

Autentiseringsuppgifter för delad nyckel.

Returer

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Skapar en instans av SASQueryParameters.

Accepterar endast nödvändiga inställningar som krävs för att skapa en SAS. För valfria inställningar anger du motsvarande egenskaper direkt, till exempel behörigheter, startsOn och identifierare.

VARNING! När identifieraren inte har angetts krävs behörigheter och expiresOn. Du MÅSTE tilldela värdet till identifieraren eller förfallerPå & behörigheter manuellt om du börjar med den här konstruktorn.

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

Parametrar

queueSASSignatureValues

QueueSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

Returer

SASQueryParameters

getQueueServiceAccountAudience(string)

Så här hämtar du OAuth-målgruppen för ett lagringskonto för kötjänsten.

function getQueueServiceAccountAudience(storageAccountName: string): string

Parametrar

storageAccountName

string

Returer

string

isPipelineLike(unknown)

En hjälpare som bestämmer om ett visst argument uppfyller pipelinekontraktet

function isPipelineLike(pipeline: unknown): pipeline

Parametrar

pipeline

unknown

Ett argument som kan vara en pipeline

Returer

pipeline

sant när argumentet uppfyller pipelinekontraktet

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Skapar ett nytt Pipeline-objekt med tillhandahållna autentiseringsuppgifter.

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

Parametrar

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.

pipelineOptions

StoragePipelineOptions

Valfritt. Alternativ.

Returer

Pipeline

Ett nytt pipelineobjekt.