@azure/storage-queue package

Klassen

AccountSASPermissions	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Dit is een helperklasse voor het maken van een tekenreeks die de machtigingen vertegenwoordigt die door een AccountSAS worden verleend. Als u een waarde instelt op true, betekent dit dat elke SAS die gebruikmaakt van deze machtigingen machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en worden ingesteld als het machtigingenveld voor een AccountSASSignatureValues-object . Het is mogelijk om de machtigingstekenreeks te maken zonder deze klasse, 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 maken 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 worden ingesteld als het veld resources in een AccountSASSignatureValues-object . Het is mogelijk om de tekenreeks van de resources te maken zonder deze klasse, maar de volgorde van de resources is bijzonder en deze klasse garandeert correctheid.
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 worden ingesteld als het veld services in een AccountSASSignatureValues-object . Het is mogelijk om de servicestekenreeks te maken zonder deze klasse, maar de volgorde van de services is bijzonder en deze klasse garandeert correctheid.
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 BELEID voor HTTP-aanvragen. U kunt een standaardpijplijn maken door newPipeline aan te roepen. U kunt ook een pijplijn met uw eigen beleid maken door de constructor van Pijplijn. 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 bijbehorende berichten kunt bewerken.
QueueSASPermissions	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Dit is een helperklasse voor het maken 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 gebruikmaakt van deze machtigingen machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en worden ingesteld als het machtigingenveld voor een QueueSASSignatureValues-object . Het is mogelijk om de machtigingstekenreeks te maken zonder deze klasse, 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 een Azure Storage SAS zijn opgebouwd. Dit type wordt niet rechtstreeks door de gebruiker samengesteld; deze wordt alleen gegenereerd door de typen AccountSASSignatureValues en QueueSASSignatureValues . Zodra deze is gegenereerd, kan deze worden gecodeerd in een toString() en rechtstreeks aan een URL worden toegevoegd (hoewel u hier voorzichtig moet zijn als er bestaande queryparameters zijn, die van invloed kunnen 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: Browsers plaatsen GET/HEAD-aanvragen in de cache 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. Cookieheader verwijderen voor beveiliging Koptekst met lengte van inhoud verwijderen om waarschuwing van browsers te voorkomen
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory is een factory-klasse die helpt bij het genereren van StorageBrowserPolicy-objecten.
StorageRetryPolicy	Beleid voor opnieuw proberen met exponentiële nieuwe pogingen en lineaire nieuwe pogingen geïmplementeerd.
StorageRetryPolicyFactory	StorageRetryPolicyFactory is een factory-klasse 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 voor het genereren van een Shared Access Signature (SAS) 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: deze klasse en SASQueryParameters bestaan omdat de eerste 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 gemeenschappelijk zijn voor elke externe bewerking.
CorsRule	CORS is een HTTP-functie waarmee een webtoepassing die wordt uitgevoerd onder één domein, toegang kan krijgen tot resources in een ander domein. Webbrowsers implementeren een beveiligingsbeperking die bekend staat als same-origin-beleid dat voorkomt 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 in een ander domein aan te roepen
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 met een verwijzing naar de aanvraag waaruit deze afkomstig is.
IHttpClient	Een compatibele interface voor core-http-aanvraagbeleid
ListQueuesSegmentResponse	Het object dat wordt geretourneerd bij het aanroepen van Lijstwachtrijen in een wachtrijservice.
Logging	Instellingen voor logboekregistratie van Azure Analytics.
MessageIdDeleteHeaders	Hiermee definieert u headers voor MessageId_delete bewerking.
MessageIdUpdateHeaders	Hiermee definieert u headers voor MessageId_update bewerking.
MessagesClearHeaders	Hiermee definieert u headers voor Messages_clear bewerking.
MessagesDequeueHeaders	Hiermee definieert u headers voor Messages_dequeue bewerking.
MessagesDequeueOptionalParams	Optionele parameters.
MessagesEnqueueHeaders	Hiermee definieert u headers voor Messages_enqueue bewerking.
MessagesEnqueueOptionalParams	Optionele parameters.
MessagesPeekHeaders	Hiermee definieert u 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 weergeven in een wachtrij
PipelineLike	Een interface voor de pijplijnklasse met beleid voor HTTP-aanvragen. U kunt een standaardpijplijn maken door newPipeline aan te roepen. U kunt ook een pijplijn met uw eigen beleid maken door de constructor van Pijplijn. Raadpleeg newPipeline en opgegeven beleidsregels voordat u uw aangepaste pijplijn implementeert.
PipelineOptions	Optie-interface voor pijplijnconstructor.
QueueClearMessagesOptions	Opties voor het configureren van de clearMessages-bewerking
QueueCreateHeaders	Hiermee definieert u headers voor Queue_create bewerking.
QueueCreateIfNotExistsResponse	Bevat antwoordgegevens voor de bewerking createIfNotExists .
QueueCreateOptions	Opties voor het configureren van de maakbewerking
QueueDeleteHeaders	Hiermee definieert u headers voor Queue_delete bewerking.
QueueDeleteIfExistsResponse	Bevat antwoordgegevens voor de bewerking deleteIfExists .
QueueDeleteMessageOptions	Opties voor het configureren van de deleteMessage-bewerking
QueueDeleteOptions	Opties voor het configureren van de verwijderbewerking
QueueExistsOptions	Opties voor het configureren van de exists-bewerking
QueueGenerateSasUrlOptions	Opties voor het configureren van de bewerking generateSasUrl .
QueueGetAccessPolicyHeaders	Hiermee definieert u headers voor Queue_getAccessPolicy bewerking.
QueueGetAccessPolicyOptions	Opties voor het configureren van de bewerking getAccessPolicy
QueueGetPropertiesHeaders	Hiermee definieert u headers voor Queue_getProperties bewerking.
QueueGetPropertiesOptions	Opties voor het configureren van de bewerking getProperties
QueueItem	Een Azure Storage-wachtrij.
QueuePeekMessagesOptions	Opties voor het configureren van de peekMessages-bewerking
QueueReceiveMessageOptions	Opties voor het configureren van de 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 de sendMessage-bewerking
QueueServiceProperties	Eigenschappen van opslagservice.
QueueServiceStatistics	Statistieken voor de opslagservice.
QueueSetAccessPolicyHeaders	Hiermee definieert u headers voor Queue_setAccessPolicy bewerking.
QueueSetAccessPolicyOptions	Opties voor het configureren van de bewerking setAccessPolicy
QueueSetMetadataHeaders	Hiermee definieert u headers voor Queue_setMetadata bewerking.
QueueSetMetadataOptions	Opties voor het configureren van de setMetadata-bewerking
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 _response eigenschap met hoofdtekst 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 de bewerking generateAccountSasUrl .
ServiceGetPropertiesHeaders	Hiermee definieert u headers voor Service_getProperties bewerking.
ServiceGetPropertiesOptions	Opties voor het configureren van de bewerking getProperties
ServiceGetStatisticsHeaders	Hiermee definieert u headers voor Service_getStatistics bewerking.
ServiceGetStatisticsOptions	Opties voor het configureren van de bewerking getStatistics
ServiceListQueuesOptions	Opties voor het configureren van listQueues-bewerking
ServiceListQueuesSegmentHeaders	Hiermee definieert u headers voor Service_listQueuesSegment bewerking.
ServiceSetPropertiesHeaders	Hiermee definieert u headers voor Service_setProperties bewerking.
ServiceSetPropertiesOptions	Opties voor het configureren van setProperties-bewerking
SignedIdentifier	Ondertekende id.
SignedIdentifierModel	ondertekende id
StoragePipelineOptions	Opties-interface voor de functie newPipeline .
StorageRetryOptions	Interface voor opties voor opnieuw proberen van Storage Blob.
WebResource	Een beschrijving van een HTTP-aanvraag die moet worden ingediend bij 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 instanties die op de aanvraag worden ondersteund. NodeJS.ReadableStream en () => NodeJS.ReadableStream is alleen Node. 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 wisbewerking.
QueueClearMessagesResponse	Bevat antwoordgegevens voor de clearMessages-bewerking .
QueueCreateResponse	Bevat antwoordgegevens voor de maakbewerking.
QueueDeleteMessageResponse	Bevat antwoordgegevens voor de deleteMessage-bewerking .
QueueDeleteResponse	Bevat antwoordgegevens voor de verwijderbewerking.
QueueGetAccessPolicyResponse	Bevat antwoordgegevens voor de bewerking getAccessPolicy .
QueueGetPropertiesResponse	Bevat antwoordgegevens voor de bewerking getProperties.
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 bewerking setAccessPolicy.
QueueSetMetadataResponse	Bevat antwoordgegevens voor de bewerking setMetadata.
QueueUpdateMessageResponse	Bevat antwoordgegevens voor de updateMessage-bewerking .
ReceivedMessageItem	Het object dat in de matrix wordt geretourneerd bij het receivedMessageItems aanroepen van receiveMessages. Zie: QueueReceiveMessageResponse
ServiceGetPropertiesResponse	Bevat antwoordgegevens voor de bewerking getProperties.
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 moet u de bijbehorende eigenschappen rechtstreeks instellen, zoals machtigingen, startsOn en id. WAARSCHUWING: als de id niet is opgegeven, zijn machtigingen en expiresOn vereist. U MOET een waarde toewijzen aan id of verlooptAan & machtigingen handmatig als u deze constructor initieert.
getQueueServiceAccountAudience(string)	OAuth-doelgroep ophalen voor een opslagaccount voor wachtrijservice.
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 waarvoor referenties zijn opgegeven.

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

Referenties voor gedeelde sleutel.

Retouren

SASQueryParameters

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 moet u de bijbehorende eigenschappen rechtstreeks instellen, zoals machtigingen, startsOn en id.

WAARSCHUWING: als de id niet is opgegeven, zijn machtigingen en expiresOn vereist. U MOET een waarde toewijzen aan id of verlooptAan & machtigingen handmatig als u deze constructor initieert.

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

Parameters

queueSASSignatureValues

QueueSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

Retouren

SASQueryParameters

getQueueServiceAccountAudience(string)

OAuth-doelgroep ophalen voor een opslagaccount voor wachtrijservice.

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 waarvoor referenties zijn opgegeven.

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

Parameters

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit 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

Optioneel. Opties.

Retouren

Pipeline

Een nieuw pijplijnobject.