@azure/storage-queue package
Klasser
| AccountSASPermissions |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att konstruera en sträng som representerar de behörigheter som beviljas av en AccountSAS. Om ett värde anges till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet på ett <xref:AccountSASSignatureValues> objekt. Det går att konstruera 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 konstruera 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 <xref:AccountSASSignatureValues>-objekt. Det går att konstruera 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 konstruera en sträng som representerar de tjänster 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 tjänsten. När alla värden har angetts ska detta serialiseras med toString och anges som tjänstfältet på ett <xref:AccountSASSignatureValues> objekt. Det går att konstruera tjänstesträ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 <xref:CredentialPolicyCreator> medlem som används för att skapa <xref:AnonymousCredentialPolicy> objekt. <xref: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-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS). |
| 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-begäranden (S) 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. Se newPipeline() och tillhandahållna principer som referens innan du implementerar din anpassade pipeline. |
| QueueClient |
En QueueClient representerar en URL till en Azure Storage-kös 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 konstruera en sträng som representerar de behörigheter som beviljas av en ServiceSAS till en kö. Om ett värde anges till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet på ett <xref:QueueSASSignatureValues> objekt. Det går att konstruera 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. |
| 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 <xref:AccountSASSignatureValues>- och <xref:QueueSASSignatureValues>-typerna. När den har genererats kan den kodas till en <xref:String> och läggas till direkt i en URL (ä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:
|
| StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory är en fabriksklass som hjälper till att generera <xref:StorageBrowserPolicy> objekt. |
| StorageClient |
En StorageClient representerar en baserad klientklass för <xref:QueueServiceClient>, <xref:QueueClient> och så vidare. |
| StorageClientContext | |
| 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 <xref: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 på rätt sätt anrop genererar anropetSASQueryParameters() för att hämta en representation av SAS som faktiskt kan tillämpas på kö-URL:er. Obs! Att både den här klassen och <xref:SASQueryParameters> finns 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. |
| 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 att ett webbprogram som körs under en domän kan komma åt resurser i en annan domän. Webbläsare implementerar en säkerhetsbegränsning som kallas samma ursprungsprincip 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 |
| ListQueuesSegmentResponse |
Objektet returnerades när listköer anropades på 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ö |
| PipelineOptions |
Alternativgränssnitt för pipelinekonstruktor. |
| QueueClearMessagesOptions |
Alternativ för att konfigurera <xref:QueueClient.clearMessages> åtgärd |
| QueueCreateHeaders |
Definierar rubriker för Queue_create åtgärd. |
| QueueCreateIfNotExistsResponse |
Innehåller svarsdata för åtgärden <xref:QueueClient.createIfNotExists>. |
| QueueCreateOptions |
Alternativ för att konfigurera <xref:QueueClient.create> åtgärd |
| QueueDeleteHeaders |
Definierar rubriker för Queue_delete åtgärd. |
| QueueDeleteIfExistsResponse |
Innehåller svarsdata för åtgärden <xref:QueueClient.deleteIfExists>. |
| QueueDeleteMessageOptions |
Alternativ för att konfigurera åtgärden <xref:QueueClient.deleteMessage> |
| QueueDeleteOptions |
Alternativ för att konfigurera <xref:QueueClient.delete> åtgärd |
| QueueExistsOptions |
Alternativ för att konfigurera <xref:QueueClient.exists> åtgärd |
| QueueGenerateSasUrlOptions |
Alternativ för att konfigurera <xref:QueueClient.generateSasUrl> åtgärd. |
| QueueGetAccessPolicyHeaders |
Definierar rubriker för Queue_getAccessPolicy åtgärd. |
| QueueGetAccessPolicyOptions |
Alternativ för att konfigurera <xref:QueueClient.getAccessPolicy> åtgärd |
| QueueGetPropertiesHeaders |
Definierar rubriker för Queue_getProperties åtgärd. |
| QueueGetPropertiesOptions |
Alternativ för att konfigurera <xref:QueueClient.getProperties> åtgärd |
| QueueItem |
En Azure Storage-kö. |
| QueuePeekMessagesOptions |
Alternativ för att konfigurera <xref:QueueClient.peekMessages> åtgärd |
| QueueReceiveMessageOptions |
Alternativ för att konfigurera <xref:QueueClient.receiveMessages> åtgärd |
| QueueSASSignatureValues |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. QueueSASSignatureValues används för att generera SAS-token för köer i kötjänsten. |
| QueueSendMessageOptions |
Alternativ för att konfigurera <xref:QueueClient.sendMessage> åtgärd |
| 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 <xref:QueueClient.setAccessPolicy> åtgärd |
| QueueSetMetadataHeaders |
Definierar rubriker för Queue_setMetadata åtgärd. |
| QueueSetMetadataOptions |
Alternativ för att konfigurera <xref:QueueClient.setMetadata> åtgärd |
| QueueUpdateMessageOptions |
Alternativ för att konfigurera <xref:QueueClient.updateMessage> åtgärd |
| RetentionPolicy |
kvarhållningsprincipen |
| SasIPRange |
Tillåtna IP-intervall för en SAS. |
| ServiceGenerateAccountSasUrlOptions |
Alternativ för att konfigurera <xref:QueueServiceClient.generateAccountSasUrl> åtgärd. |
| ServiceGetPropertiesHeaders |
Definierar rubriker för Service_getProperties åtgärd. |
| ServiceGetPropertiesOptions |
Alternativ för att konfigurera <xref:QueueServiceClient.getProperties> åtgärd |
| ServiceGetStatisticsHeaders |
Definierar rubriker för Service_getStatistics åtgärd. |
| ServiceGetStatisticsOptions |
Alternativ för att konfigurera <xref:QueueServiceClient.getStatistics> åtgärd |
| ServiceListQueuesOptions |
Alternativ för att konfigurera <xref:QueueServiceClient.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 <xref:QueueServiceClient.setProperties> åtgärd |
| SignedIdentifier |
Signerad identifierare. |
| SignedIdentifierModel |
signerad identifierare |
| StorageClientOptionalParams |
Valfria parametrar. |
| StoragePipelineOptions |
Alternativgränssnitt för metoden newPipeline(). |
| StorageRetryOptions |
Alternativ för återförsök av lagringskö. |
Typalias
| CredentialPolicyCreator |
En fabriksfunktion som skapar en ny CredentialPolicy som använder den angivna nextPolicy. |
| GeoReplicationStatusType |
Definierar värden för GeoReplicationStatusType. |
| 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 <xref:QueueClient.clearMessages>. |
| QueueCreateResponse |
Innehåller svarsdata för skapandeåtgärden. |
| QueueDeleteMessageResponse |
Innehåller svarsdata för åtgärden <xref:QueueClient.deleteMessage>. |
| QueueDeleteResponse |
Innehåller svarsdata för borttagningsåtgärden. |
| QueueGetAccessPolicyResponse |
Innehåller svarsdata för åtgärden <xref:QueueClient.getAccessPolicy>. |
| QueueGetPropertiesResponse |
Innehåller svarsdata för åtgärden getProperties. |
| QueuePeekMessagesResponse |
Innehåller svarsdata för åtgärden <xref:QueueClient.peekMessages>. |
| QueueReceiveMessageResponse |
Innehåller svarsdata för åtgärden <xref:QueueClient.receiveMessages>. |
| QueueSendMessageResponse |
Innehåller svarsdata för åtgärden <xref:QueueClient.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 <xref:QueueClient.updateMessage>. |
| ReceivedMessageItem |
Objektet som returnerades i matrisen |
| ServiceGetPropertiesResponse |
Innehåller svarsdata för åtgärden getProperties. |
| ServiceGetStatisticsResponse |
Innehåller svarsdata för åtgärden getStatistics. |
| ServiceListQueuesSegmentResponse |
Innehåller svarsdata för åtgärden listQueuesSegment. |
| ServiceSetPropertiesResponse |
Innehåller svarsdata för åtgärden setProperties. |
Uppräkningar
| SASProtocol |
Protokoll för genererad SAS. |
| StorageRetryPolicyType |
RetryPolicy-typer. |
Funktioner
| generate |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Genererar ett <xref:SASQueryParameters> objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran. |
| generate |
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. |
| new |
Skapar ett nytt pipelineobjekt med angivna autentiseringsuppgifter. |
Funktionsinformation
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Genererar ett <xref:SASQueryParameters> objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran.
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
Parametrar
- accountSASSignatureValues
- AccountSASSignatureValues
SAS-signaturvärden för kontot
- sharedKeyCredential
- StorageSharedKeyCredential
Autentiseringsuppgifter för delad nyckel.
Returer
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)
Parametrar
- queueSASSignatureValues
- QueueSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Returer
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Skapar ett nytt pipelineobjekt med angivna autentiseringsuppgifter.
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions)
Parametrar
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från @azure/identity-paketet för att autentisera 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
Alternativ.
Returer
Ett nytt pipelineobjekt.