@azure/storage-queue package
Klassen
| AccountSASPermissions |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Dit is een helperklasse voor het samenstellen van een tekenreeks die de machtigingen vertegenwoordigt die zijn verleend door een AccountSAS. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het machtigingsveld voor een <xref:AccountSASSignatureValues>-object. Het is mogelijk om de machtigingstekenreeks zonder deze klasse samen te stellen, maar de volgorde van de machtigingen is bijzonder en deze klasse garandeert juistheid. |
| AccountSASResourceTypes |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Dit is een helperklasse voor het samenstellen van een tekenreeks die de resources vertegenwoordigt die toegankelijk zijn voor een AccountSAS. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, toegang verleent tot dat resourcetype. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het resourceveld op een <xref:AccountSASSignatureValues>-object. Het is mogelijk om de tekenreeks voor resources zonder deze klasse samen te stellen, maar de volgorde van de resources is bijzonder en deze klasse garandeert juistheid. |
| AccountSASServices |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Dit is een helperklasse voor het samenstellen van een tekenreeks die de services vertegenwoordigt die toegankelijk zijn voor een AccountSAS. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, toegang verleent tot die service. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het servicesveld op een <xref:AccountSASSignatureValues>-object. Het is mogelijk om de servicesreeks zonder deze klasse samen te stellen, maar de volgorde van de services is bijzonder en deze klasse garandeert juistheid. |
| AnonymousCredential |
AnonymousCredential biedt een <xref:CredentialPolicyCreator> lid dat wordt gebruikt om <xref:AnonymousCredentialPolicy> objecten te maken. <xref:AnonymousCredentialPolicy> wordt gebruikt met HTTP(S)-aanvragen die openbare resources lezen of voor gebruik met Shared Access Signatures (SAS). |
| AnonymousCredentialPolicy |
AnonymousCredentialPolicy wordt gebruikt met HTTP(S)-aanvragen die openbare resources lezen of voor gebruik met Shared Access Signatures (SAS). |
| Credential |
Referentie is een abstracte klasse voor ondertekening van HTTP-aanvragen voor Azure Storage. Deze klasse host een credentialPolicyCreator-factory die CredentialPolicy genereert. |
| CredentialPolicy |
Referentiebeleid dat wordt gebruikt om HTTP(S)-aanvragen te ondertekenen voordat deze worden verzonden. Dit is een abstracte klasse. |
| Pipeline |
Een pijplijnklasse met HTTP-aanvraagbeleid. U kunt een standaardpijplijn maken door newPipeline() aan te roepen. U kunt ook een pijplijn maken met uw eigen beleid door de constructor van Pipeline. Raadpleeg newPipeline() en opgegeven beleidsregels als referentie voordat u uw aangepaste pijplijn implementeert. |
| QueueClient |
Een QueueClient vertegenwoordigt een URL naar de berichten van een Azure Storage-wachtrij, zodat u de berichten kunt bewerken. |
| QueueSASPermissions |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Dit is een helperklasse voor het samenstellen van een tekenreeks die de machtigingen vertegenwoordigt die door een ServiceSAS aan een wachtrij worden verleend. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het machtigingsveld voor een <xref:QueueSASSignatureValues> object. Het is mogelijk om de machtigingstekenreeks zonder deze klasse samen te stellen, maar de volgorde van de machtigingen is bijzonder en deze klasse garandeert juistheid. |
| QueueServiceClient |
Een QueueServiceClient vertegenwoordigt een URL naar de Azure Storage Queue-service waarmee u wachtrijen kunt bewerken. |
| SASQueryParameters |
Vertegenwoordigt de onderdelen waaruit de queryparameters van Azure Storage SAS bestaan. Dit type wordt niet rechtstreeks samengesteld door de gebruiker; deze wordt alleen gegenereerd door de typen <xref:AccountSASSignatureValues> en <xref:QueueSASSignatureValues>. Zodra deze is gegenereerd, kan deze worden gecodeerd in een <xref:String> en rechtstreeks aan een URL worden toegevoegd (hoewel hier voorzichtigheid moet worden genomen als er bestaande queryparameters zijn, wat van invloed kan zijn op de juiste manier om deze queryparameters toe te voegen). OPMERKING: Exemplaren van deze klasse zijn onveranderbaar. |
| StorageBrowserPolicy |
StorageBrowserPolicy verwerkt verschillen tussen Node.js en browserruntime, waaronder:
|
| StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory is een factoryklasse die helpt bij het genereren van <xref:StorageBrowserPolicy> objecten. |
| StorageClient |
Een StorageClient vertegenwoordigt een gebaseerde clientklasse voor <xref:QueueServiceClient>, <xref:QueueClient> en enzovoort. |
| StorageClientContext | |
| StorageRetryPolicy |
Beleid voor opnieuw proberen met exponentieel opnieuw proberen en lineaire nieuwe poging geïmplementeerd. |
| StorageRetryPolicyFactory |
StorageRetryPolicyFactory is een fabrieksklasse die helpt bij het genereren van <xref:StorageRetryPolicy> objecten. |
| StorageSharedKeyCredential |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. StorageSharedKeyCredential voor accountsleutelautorisatie van de Azure Storage-service. |
| StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy is een beleid dat wordt gebruikt om een HTTP-aanvraag te ondertekenen met een gedeelde sleutel. |
Interfaces
| AccessPolicy |
Een toegangsbeleid |
| AccountSASSignatureValues |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. AccountSASSignatureValues wordt gebruikt om een Shared Access Signature (SAS) te genereren voor een Azure Storage-account. Zodra alle waarden hier correct zijn ingesteld, roept u generateSASQueryParameters() aan om een weergave van de SAS te verkrijgen die daadwerkelijk kan worden toegepast op wachtrij-URL's. Opmerking: zowel deze klasse als <xref:SASQueryParameters> bestaan omdat de vorige veranderlijk is en een logische representatie terwijl de laatste onveranderbaar is en wordt gebruikt om werkelijke REST-aanvragen te genereren. |
| CommonOptions |
Een interface voor opties die gebruikelijk zijn voor elke externe bewerking. |
| CorsRule |
CORS is een HTTP-functie waarmee een webtoepassing die onder het ene domein wordt uitgevoerd, toegang heeft tot resources in een ander domein. Webbrowsers implementeren een beveiligingsbeperking die bekend staat als beleid voor dezelfde oorsprong waarmee wordt voorkomen dat een webpagina API's in een ander domein aanroept; CORS biedt een veilige manier om het ene domein (het oorspronkelijke domein) toe te staan API's aan te roepen in een ander domein |
| DequeuedMessageItem |
Het object dat wordt geretourneerd in de matrix QueueMessageList bij het aanroepen van Berichten ophalen in een wachtrij. |
| EnqueuedMessage |
Het object dat wordt geretourneerd in de matrix QueueMessageList bij het aanroepen van Bericht in een wachtrij plaatsen |
| GeoReplication |
Geo-Replication informatie voor de secundaire opslagservice |
| ListQueuesSegmentResponse |
Het object dat wordt geretourneerd bij het aanroepen van lijstwachtrijen in een wachtrijservice. |
| Logging |
Instellingen voor Logboekregistratie van Azure Analytics. |
| MessageIdDeleteHeaders |
Definieert headers voor MessageId_delete bewerking. |
| MessageIdUpdateHeaders |
Definieert headers voor MessageId_update bewerking. |
| MessagesClearHeaders |
Definieert headers voor Messages_clear bewerking. |
| MessagesDequeueHeaders |
Definieert headers voor Messages_dequeue bewerking. |
| MessagesDequeueOptionalParams |
Optionele parameters. |
| MessagesEnqueueHeaders |
Definieert headers voor Messages_enqueue bewerking. |
| MessagesEnqueueOptionalParams |
Optionele parameters. |
| MessagesPeekHeaders |
Definieert headers voor Messages_peek bewerking. |
| MessagesPeekOptionalParams |
Optionele parameters. |
| Metadata |
Een verzameling sleutel-waardetekenreeksparen. |
| Metrics |
Een interface die metrische gegevens vertegenwoordigt. |
| PeekedMessageItem |
Het object dat wordt geretourneerd in de matrix QueueMessageList bij het aanroepen van Berichten in een wachtrij weergeven |
| PipelineOptions |
Optie-interface voor pijplijnconstructor. |
| QueueClearMessagesOptions |
Opties voor het configureren van <xref:QueueClient.clearMessages> bewerking |
| QueueCreateHeaders |
Definieert headers voor Queue_create bewerking. |
| QueueCreateIfNotExistsResponse |
Bevat antwoordgegevens voor de <xref:QueueClient.createIfNotExists>-bewerking. |
| QueueCreateOptions |
Opties voor het configureren van <xref:QueueClient.create> bewerking |
| QueueDeleteHeaders |
Definieert headers voor Queue_delete bewerking. |
| QueueDeleteIfExistsResponse |
Bevat antwoordgegevens voor de <xref:QueueClient.deleteIfExists>-bewerking. |
| QueueDeleteMessageOptions |
Opties voor het configureren van de <xref:QueueClient.deleteMessage>-bewerking |
| QueueDeleteOptions |
Opties voor het configureren van <xref:QueueClient.delete> bewerking |
| QueueExistsOptions |
Opties voor het configureren van <xref:QueueClient.exists> bewerking |
| QueueGenerateSasUrlOptions |
Opties voor het configureren van <xref:QueueClient.generateSasUrl> bewerking. |
| QueueGetAccessPolicyHeaders |
Definieert headers voor Queue_getAccessPolicy bewerking. |
| QueueGetAccessPolicyOptions |
Opties voor het configureren van <xref:QueueClient.getAccessPolicy> bewerking |
| QueueGetPropertiesHeaders |
Definieert headers voor Queue_getProperties bewerking. |
| QueueGetPropertiesOptions |
Opties voor het configureren van <xref:QueueClient.getProperties> bewerking |
| QueueItem |
Een Azure Storage-wachtrij. |
| QueuePeekMessagesOptions |
Opties voor het configureren van <xref:QueueClient.peekMessages> bewerking |
| QueueReceiveMessageOptions |
Opties voor het configureren van <xref:QueueClient.receiveMessages> bewerking |
| QueueSASSignatureValues |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. QueueSASSignatureValues wordt gebruikt om SAS-tokens voor wachtrijen te genereren. |
| QueueSendMessageOptions |
Opties voor het configureren van <xref:QueueClient.sendMessage> bewerking |
| QueueServiceProperties |
Eigenschappen van opslagservice. |
| QueueServiceStatistics |
Statistieken voor de opslagservice. |
| QueueSetAccessPolicyHeaders |
Definieert headers voor Queue_setAccessPolicy bewerking. |
| QueueSetAccessPolicyOptions |
Opties voor het configureren van <xref:QueueClient.setAccessPolicy> bewerking |
| QueueSetMetadataHeaders |
Definieert headers voor Queue_setMetadata bewerking. |
| QueueSetMetadataOptions |
Opties voor het configureren van <xref:QueueClient.setMetadata> bewerking |
| QueueUpdateMessageOptions |
Opties voor het configureren van <xref:QueueClient.updateMessage> bewerking |
| RetentionPolicy |
het bewaarbeleid |
| SasIPRange |
Toegestaan IP-bereik voor een SAS. |
| ServiceGenerateAccountSasUrlOptions |
Opties voor het configureren van <xref:QueueServiceClient.generateAccountSasUrl> bewerking. |
| ServiceGetPropertiesHeaders |
Definieert headers voor Service_getProperties bewerking. |
| ServiceGetPropertiesOptions |
Opties voor het configureren van <xref:QueueServiceClient.getProperties> bewerking |
| ServiceGetStatisticsHeaders |
Definieert headers voor Service_getStatistics bewerking. |
| ServiceGetStatisticsOptions |
Opties voor het configureren van <xref:QueueServiceClient.getStatistics> bewerking |
| ServiceListQueuesOptions |
Opties voor het configureren van <xref:QueueServiceClient.listQueues> bewerking |
| ServiceListQueuesSegmentHeaders |
Definieert headers voor Service_listQueuesSegment bewerking. |
| ServiceSetPropertiesHeaders |
Definieert headers voor Service_setProperties bewerking. |
| ServiceSetPropertiesOptions |
Opties voor het configureren van <xref:QueueServiceClient.setProperties> bewerking |
| SignedIdentifier |
Ondertekende id. |
| SignedIdentifierModel |
ondertekende id |
| StorageClientOptionalParams |
Optionele parameters. |
| StoragePipelineOptions |
Optie-interface voor methode newPipeline(). |
| StorageRetryOptions |
Interface voor opties voor opnieuw proberen van opslagwachtrij. |
Type-aliassen
| CredentialPolicyCreator |
Een factory-functie die een nieuwe CredentialPolicy maakt die gebruikmaakt van de opgegeven nextPolicy. |
| GeoReplicationStatusType |
Definieert waarden voor GeoReplicationStatusType. |
| ListQueuesIncludeType |
Definieert waarden voor ListQueuesIncludeType. Mogelijke waarden zijn: 'metagegevens' |
| MessageIdDeleteResponse |
Bevat antwoordgegevens voor de verwijderbewerking. |
| MessageIdUpdateResponse |
Bevat antwoordgegevens voor de updatebewerking. |
| MessagesClearResponse |
Bevat antwoordgegevens voor de duidelijke bewerking. |
| QueueClearMessagesResponse |
Bevat antwoordgegevens voor de <xref:QueueClient.clearMessages>-bewerking. |
| QueueCreateResponse |
Bevat antwoordgegevens voor de bewerking maken. |
| QueueDeleteMessageResponse |
Bevat antwoordgegevens voor de <xref:QueueClient.deleteMessage>-bewerking. |
| QueueDeleteResponse |
Bevat antwoordgegevens voor de verwijderbewerking. |
| QueueGetAccessPolicyResponse |
Bevat antwoordgegevens voor de <xref:QueueClient.getAccessPolicy>-bewerking. |
| QueueGetPropertiesResponse |
Bevat antwoordgegevens voor de getProperties-bewerking. |
| QueuePeekMessagesResponse |
Bevat de antwoordgegevens voor de <xref:QueueClient.peekMessages>-bewerking. |
| QueueReceiveMessageResponse |
Bevat de antwoordgegevens voor de <xref:QueueClient.receiveMessages>-bewerking. |
| QueueSendMessageResponse |
Bevat de antwoordgegevens voor de <xref:QueueClient.sendMessage>-bewerking. |
| QueueSetAccessPolicyResponse |
Bevat antwoordgegevens voor de setAccessPolicy-bewerking. |
| QueueSetMetadataResponse |
Bevat antwoordgegevens voor de setMetadata-bewerking. |
| QueueUpdateMessageResponse |
Bevat antwoordgegevens voor de <xref:QueueClient.updateMessage>-bewerking. |
| ReceivedMessageItem |
Het object dat wordt geretourneerd in de |
| ServiceGetPropertiesResponse |
Bevat antwoordgegevens voor de getProperties-bewerking. |
| ServiceGetStatisticsResponse |
Bevat antwoordgegevens voor de bewerking getStatistics. |
| ServiceListQueuesSegmentResponse |
Bevat antwoordgegevens voor de bewerking listQueuesSegment. |
| ServiceSetPropertiesResponse |
Bevat antwoordgegevens voor de bewerking setProperties. |
Enums
| SASProtocol |
Protocollen voor gegenereerde SAS. |
| StorageRetryPolicyType |
RetryPolicy-typen. |
Functies
| generate |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee wordt een <xref:SASQueryParameters>-object gegenereerd dat alle SAS-queryparameters bevat die nodig zijn om een werkelijke REST-aanvraag te maken. |
| generate |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee maakt u een exemplaar van SASQueryParameters. Accepteert alleen vereiste instellingen die nodig zijn om een SAS te maken. Voor optionele instellingen stelt u de bijbehorende eigenschappen rechtstreeks in, zoals machtigingen, startsOn en id. WAARSCHUWING: Wanneer de id niet is opgegeven, zijn machtigingen en expiresOn vereist. U MOET waarde toewijzen aan id of expiresOn & machtigingen handmatig als u in eerste instantie met deze constructor begint. |
| new |
Hiermee maakt u een nieuw pijplijnobject met de opgegeven referentie. |
Functiedetails
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee wordt een <xref:SASQueryParameters>-object gegenereerd dat alle SAS-queryparameters bevat die nodig zijn om een werkelijke REST-aanvraag te maken.
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)Parameters
- accountSASSignatureValues
- AccountSASSignatureValues
SAS-handtekeningwaarden van het account
- sharedKeyCredential
- StorageSharedKeyCredential
Gedeelde sleutelreferenties.
Retouren
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee maakt u een exemplaar van SASQueryParameters.
Accepteert alleen vereiste instellingen die nodig zijn om een SAS te maken. Voor optionele instellingen stelt u de bijbehorende eigenschappen rechtstreeks in, zoals machtigingen, startsOn en id.
WAARSCHUWING: Wanneer de id niet is opgegeven, zijn machtigingen en expiresOn vereist. U MOET waarde toewijzen aan id of expiresOn & machtigingen handmatig als u in eerste instantie met deze constructor begint.
function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)Parameters
- queueSASSignatureValues
- QueueSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Retouren
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Hiermee maakt u een nieuw pijplijnobject met de opgegeven referentie.
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions)Parameters
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Zoals AnonymousCredential, StorageSharedKeyCredential of referenties van het @azure/identity-pakket om aanvragen voor de service te verifiëren. U kunt ook een object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.
- pipelineOptions
- StoragePipelineOptions
Opties.
Retouren
Een nieuw pijplijnobject.
