Delen via


@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 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 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 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 credentialPolicyCreator-lid dat wordt gebruikt om AnonymousCredentialPolicy-objecten te maken. 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).

BaseRequestPolicy

De basisklasse waaruit alle aanvraagbeleidsregels zijn afgeleid.

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

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

SASQueryParameters

Vertegenwoordigt de onderdelen waaruit de queryparameters van Azure Storage SAS bestaan. Dit type wordt niet rechtstreeks samengesteld door de gebruiker; het wordt alleen gegenereerd door de AccountSASSignatureValues en QueueSASSignatureValues typen. Zodra deze is gegenereerd, kan deze worden gecodeerd in een toString() 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:

  1. Browsers slaan GET/HEAD-aanvragen in de cache op door voorwaardelijke headers toe te voegen, zoals 'IF_MODIFIED_SINCE'. StorageBrowserPolicy is een beleid dat wordt gebruikt om een tijdstempelquery toe te voegen aan de GET/HEAD-aanvraag-URL, waardoor de browsercache wordt vermeden.

  2. Cookieheader verwijderen voor beveiliging

  3. Inhoudslengtekop verwijderen om waarschuwing van browsers te voorkomen

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory is een factoryklasse die helpt bij het genereren van StorageBrowserPolicy-objecten.

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 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 SASQueryParameters bestaan omdat het voormalige veranderlijk is en een logische weergave terwijl de laatste onveranderbaar is en wordt gebruikt om werkelijke REST-aanvragen te genereren.

Zie https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 voor meer conceptuele informatie over SAS Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas voor beschrijvingen van de parameters, waaronder welke vereist zijn

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

HttpHeaders

Een verzameling HTTP-headersleutel-waardeparen.

HttpOperationResponse

Http-antwoord dat compatibel is met core-v1 (core-http).

HttpResponse

Een weergave van een HTTP-antwoord dat een verwijzing bevat naar de aanvraag die het heeft veroorzaakt.

IHttpClient

Een compatibele interface voor beleid voor core-http-aanvragen

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

PipelineLike

Een interface voor de Pipeline-klasse 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 voordat u uw aangepaste pijplijn implementeert.

PipelineOptions

Optie-interface voor pijplijnconstructor.

QueueClearMessagesOptions

Opties voor het configureren van clearMessages bewerking

QueueCreateHeaders

Definieert headers voor Queue_create bewerking.

QueueCreateIfNotExistsResponse

Bevat antwoordgegevens voor de createIfNotExists bewerking.

QueueCreateOptions

Opties voor het configureren van maken van bewerking

QueueDeleteHeaders

Definieert headers voor Queue_delete bewerking.

QueueDeleteIfExistsResponse

Bevat antwoordgegevens voor de deleteIfExists bewerking.

QueueDeleteMessageOptions

Opties voor het configureren van de bewerking deleteMessage

QueueDeleteOptions

Opties voor het configureren van bewerking verwijderen

QueueExistsOptions

Opties voor het configureren van bestaat bewerking

QueueGenerateSasUrlOptions

Opties voor het configureren van generateSasUrl--bewerking.

QueueGetAccessPolicyHeaders

Definieert headers voor Queue_getAccessPolicy bewerking.

QueueGetAccessPolicyOptions

Opties voor het configureren van getAccessPolicy-bewerking

QueueGetPropertiesHeaders

Definieert headers voor Queue_getProperties bewerking.

QueueGetPropertiesOptions

Opties voor het configureren van getProperties bewerking

QueueItem

Een Azure Storage-wachtrij.

QueuePeekMessagesOptions

Opties voor het configureren van peekMessages bewerking

QueueReceiveMessageOptions

Opties voor het configureren van 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 sendMessage--bewerking

QueueServiceProperties

Eigenschappen van opslagservice.

QueueServiceStatistics

Statistieken voor de opslagservice.

QueueSetAccessPolicyHeaders

Definieert headers voor Queue_setAccessPolicy bewerking.

QueueSetAccessPolicyOptions

Opties voor het configureren van setAccessPolicy--bewerking

QueueSetMetadataHeaders

Definieert headers voor Queue_setMetadata bewerking.

QueueSetMetadataOptions

Opties voor het configureren van bewerking setMetadata

QueueUpdateMessageOptions

Opties voor het configureren van updateMessage bewerking

RequestPolicyFactory

Een interface voor compatibiliteit met requestPolicyFactory van core-http

RequestPolicyOptions

Een interface voor compatibiliteit met RequestPolicy

ResponseLike

Een object met een eenvoudige _response eigenschap.

ResponseWithBody

Een object met een eigenschap _response met hoofdteksten en kopteksten die al zijn geparseerd in bekende typen.

ResponseWithHeaders

Een object met een _response eigenschap met kopteksten die al zijn geparseerd in een getypt object.

RetentionPolicy

het bewaarbeleid

SasIPRange

Toegestaan IP-bereik voor een SAS.

ServiceClientOptions

Een subset van @azure/core-http ServiceClientOptions

ServiceGenerateAccountSasUrlOptions

Opties voor het configureren van generateAccountSasUrl bewerking.

ServiceGetPropertiesHeaders

Definieert headers voor Service_getProperties bewerking.

ServiceGetPropertiesOptions

Opties voor het configureren van getProperties bewerking

ServiceGetStatisticsHeaders

Definieert headers voor Service_getStatistics bewerking.

ServiceGetStatisticsOptions

Opties voor het configureren van getStatistics bewerking

ServiceListQueuesOptions

Opties voor het configureren van bewerking listQueues

ServiceListQueuesSegmentHeaders

Definieert headers voor Service_listQueuesSegment bewerking.

ServiceSetPropertiesHeaders

Definieert headers voor Service_setProperties bewerking.

ServiceSetPropertiesOptions

Opties voor het configureren van bewerking setProperties

SignedIdentifier

Ondertekende id.

SignedIdentifierModel

ondertekende id

StoragePipelineOptions

Optiesinterface voor de functie newPipeline.

StorageRetryOptions

Interface voor opties voor opnieuw proberen van Opslagblob.

WebResource

Een beschrijving van een HTTP-aanvraag die moet worden gedaan op een externe server.

Type-aliassen

CredentialPolicyCreator

Een factory-functie die een nieuwe CredentialPolicy maakt die gebruikmaakt van de opgegeven nextPolicy.

GeoReplicationStatusType

Definieert waarden voor GeoReplicationStatusType.

HttpRequestBody

Typen lichamen die op de aanvraag worden ondersteund. NodeJS.ReadableStream en () => NodeJS.ReadableStream is alleen knooppunt. Blob, ReadableStream en () => ReadableStream zijn alleen browser.

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 clearMessages bewerking.

QueueCreateResponse

Bevat antwoordgegevens voor de bewerking maken.

QueueDeleteMessageResponse

Bevat antwoordgegevens voor de deleteMessage bewerking.

QueueDeleteResponse

Bevat antwoordgegevens voor de verwijderbewerking.

QueueGetAccessPolicyResponse

Bevat antwoordgegevens voor de getAccessPolicy--bewerking.

QueueGetPropertiesResponse

Bevat antwoordgegevens voor de getProperties-bewerking.

QueuePeekMessagesResponse

Bevat de antwoordgegevens voor de peekMessages bewerking.

QueueReceiveMessageResponse

Bevat de antwoordgegevens voor de receiveMessages bewerking.

QueueSendMessageResponse

Bevat de antwoordgegevens voor de sendMessage--bewerking.

QueueSetAccessPolicyResponse

Bevat antwoordgegevens voor de setAccessPolicy-bewerking.

QueueSetMetadataResponse

Bevat antwoordgegevens voor de setMetadata-bewerking.

QueueUpdateMessageResponse

Bevat antwoordgegevens voor de updateMessage--bewerking.

ReceivedMessageItem

Het object dat wordt geretourneerd in de receivedMessageItems matrix bij het aanroepen van receiveMessages.

Zie: QueueReceiveMessageResponse-

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.

WithResponse

Een type dat een bewerkingsresultaat vertegenwoordigt met een bekende eigenschap _response.

Enums

SASProtocol

Protocollen voor gegenereerde SAS.

StorageQueueAudience

Definieert de bekende clouddoelgroepen voor Opslag.

StorageRetryPolicyType

RetryPolicy-typen.

Functies

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee wordt een SASQueryParameters object gegenereerd dat alle SAS-queryparameters bevat die nodig zijn om een werkelijke REST-aanvraag te maken.

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

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.

getQueueServiceAccountAudience(string)

OAuth-doelgroep voor een opslagaccount voor wachtrijservice ophalen.

isPipelineLike(unknown)

Een helper om te bepalen of een bepaald argument voldoet aan het pijplijncontract

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Hiermee maakt u een nieuw pijplijnobject met de opgegeven referentie.

Functiedetails

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee wordt een SASQueryParameters object gegenereerd dat alle SAS-queryparameters bevat die nodig zijn om een werkelijke REST-aanvraag te maken.

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

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

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

Parameters

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Retouren

getQueueServiceAccountAudience(string)

OAuth-doelgroep voor een opslagaccount voor wachtrijservice ophalen.

function getQueueServiceAccountAudience(storageAccountName: string): string

Parameters

storageAccountName

string

Retouren

string

isPipelineLike(unknown)

Een helper om te bepalen of een bepaald argument voldoet aan het pijplijncontract

function isPipelineLike(pipeline: unknown): pipeline

Parameters

pipeline

unknown

Een argument dat een pijplijn kan zijn

Retouren

pipeline

waar wanneer het argument voldoet aan het pijplijncontract

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Hiermee maakt u een nieuw pijplijnobject met de opgegeven referentie.

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

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

Facultatief. Opties.

Retouren

Een nieuw pijplijnobject.