@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 machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en worden ingesteld als het machtigingsveld voor een AccountSASSignatureValues-object . Het is mogelijk om de machtigingsreeks 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 voor resources te maken zonder deze klasse, 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 maken 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 servicetekenreeks te maken zonder deze klasse, 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. |
HttpHeaders |
Een verzameling http-headersleutel-waardeparen. |
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 pijplijn. 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 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. |
RequestPolicyOptions |
Optionele eigenschappen die kunnen worden gebruikt bij het maken van een RequestPolicy. |
RestError |
Een fout die het gevolg is van een HTTP-aanvraag naar een service-eindpunt. |
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:
|
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. |
WebResource |
Hiermee maakt u een nieuw WebResource-object. Deze klasse biedt een abstractie van een REST-aanroep door bibliotheek-/implementatieneutraal te zijn en de benodigde eigenschappen te verpakken om een aanvraag te starten. |
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: zowel deze klasse als SASQueryParameters bestaan omdat de eerste veranderlijk en een logische weergave is, 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 bij elke bewerking op afstand worden gebruikt. |
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 één 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 queueMessageList-matrix bij het aanroepen van Bericht plaatsen in een wachtrij |
GeoReplication |
Geo-Replication informatie voor de secundaire opslagservice |
HttpOperationResponse |
Wrapper-object voor http-aanvraag en -antwoord. Het gedeserialiseerde object wordt opgeslagen in de |
IHttpClient |
Een interface die HttpRequests kan verzenden en beloofde HttpResponses kan ontvangen. |
ListQueuesSegmentResponse |
Het object dat wordt geretourneerd bij het aanroepen van List Queues op een Queue Service. |
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 Kort weergeven berichten in een wachtrij |
PipelineOptions |
Optie-interface voor pijplijnconstructor. |
QueueClearMessagesOptions |
Opties voor het configureren van 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 |
RequestPolicy |
De onderliggende structuur van een aanvraagbeleid. |
RetentionPolicy |
het bewaarbeleid |
SasIPRange |
Toegestaan IP-bereik voor een SAS. |
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 |
Optie-interface voor newPipeline()-methode. |
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. |
HttpRequestBody |
Mogelijke typen HTTP-aanvraagbody |
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 |
RequestPolicyFactory |
Hiermee maakt u een nieuwe RequestPolicy per aanvraag die gebruikmaakt van de opgegeven nextPolicy. |
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. |
Enums
SASProtocol |
Protocollen voor gegenereerde SAS. |
StorageQueueAudience |
Definieert de bekende clouddoelgroepen voor Opslag. |
StorageRetryPolicyType |
RetryPolicy-typen. |
Functies
deserialization |
Maak een nieuwe serialisatie RequestPolicyCreator waarmee HTTP-aanvraagbody's worden geserialiseerd wanneer ze de HTTP-pijplijn passeren. |
generate |
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 |
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 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. |
get |
|
new |
Hiermee maakt u een nieuw pijplijnobject waarvoor referenties zijn opgegeven. |
Functiedetails
deserializationPolicy(DeserializationContentTypes, SerializerOptions)
Maak een nieuwe serialisatie RequestPolicyCreator waarmee HTTP-aanvraagbody's worden geserialiseerd wanneer ze de HTTP-pijplijn passeren.
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory
Parameters
- deserializationContentTypes
- DeserializationContentTypes
- parsingOptions
- SerializerOptions
Retouren
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
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
getQueueServiceAccountAudience(string)
function getQueueServiceAccountAudience(storageAccountName: string): string
Parameters
- storageAccountName
-
string
Retouren
string
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
Opties.
Retouren
Een nieuw pijplijnobject.