@azure/storage-queue package

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die von einem AccountSAS gewährten Berechtigungen darstellt. Das Festlegen eines Werts auf true bedeutet, dass jede SAS, die diese Berechtigungen verwendet, Berechtigungen für diesen Vorgang erteilt. Sobald alle Werte festgelegt sind, sollte dies mit toString serialisiert und als Berechtigungsfeld für ein AccountSASSignatureValues-Objekt festgelegt werden. Es ist möglich, die Berechtigungszeichenfolge ohne diese Klasse zu erstellen, aber die Reihenfolge der Berechtigungen ist besonders, und diese Klasse garantiert die Richtigkeit.

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die Ressourcen darstellt, auf die ein AccountSAS zugreifen kann. Das Festlegen eines Werts auf true bedeutet, dass jede SAS, die diese Berechtigungen verwendet, Zugriff auf diesen Ressourcentyp gewährt. Sobald alle Werte festgelegt sind, sollte dies mit toString serialisiert und als Ressourcenfeld für ein AccountSASSignatureValues-Objekt festgelegt werden. Es ist möglich, die Ressourcenzeichenfolge ohne diese Klasse zu erstellen, aber die Reihenfolge der Ressourcen ist besonders, und diese Klasse garantiert die Richtigkeit.

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die Dienste darstellt, auf die ein AccountSAS zugreifen kann. Das Festlegen eines Werts auf true bedeutet, dass jede SAS, die diese Berechtigungen verwendet, Zugriff auf diesen Dienst gewährt. Sobald alle Werte festgelegt sind, sollte dies mit toString serialisiert und als Dienstfeld für ein AccountSASSignatureValues-Objekt festgelegt werden. Es ist möglich, die Dienstzeichenfolge ohne diese Klasse zu erstellen, aber die Reihenfolge der Dienste ist besonders, und diese Klasse garantiert die Richtigkeit.

AnonymousCredential stellt ein credentialPolicyCreator-Member bereit, das zum Erstellen von AnonymousCredentialPolicy-Objekten verwendet wird. AnonymousCredentialPolicy wird mit HTTP(S)-Anforderungen verwendet, die öffentliche Ressourcen lesen, oder für die Verwendung mit Shared Access Signatures (SAS).

AnonymousCredentialPolicy wird mit HTTP(S)-Anforderungen verwendet, die öffentliche Ressourcen lesen, oder für die Verwendung mit Shared Access Signatures (SAS).

Die Basisklasse, von der alle Anforderungsrichtlinien abgeleitet werden.

Anmeldeinformationen sind eine abstrakte Klasse für die Signatur von HTTP-Anforderungen in Azure Storage. Diese Klasse hostt eine credentialPolicyCreator-Factory, die CredentialPolicy generiert.

Anmeldeinformationsrichtlinie, die zum Signieren von HTTP(S)-Anforderungen vor dem Senden verwendet wird. Dies ist eine abstrakte Klasse.

Eine Pipelineklasse mit HTTP-Anforderungsrichtlinien. Sie können eine Standardpipeline erstellen, indem Sie newPipeline aufrufen. Alternativ können Sie eine Pipeline mit Ihren eigenen Richtlinien durch den Konstruktor von Pipeline erstellen.

Lesen Sie newPipeline und bereitgestellte Richtlinien, bevor Sie Ihre angepasste Pipeline implementieren.

Ein QueueClient stellt eine URL zu den Nachrichten einer Azure Storage-Warteschlange dar, mit der Sie deren Nachrichten bearbeiten können.

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die Berechtigungen darstellt, die von einem ServiceSAS für eine Warteschlange erteilt werden. Das Festlegen eines Werts auf true bedeutet, dass jede SAS, die diese Berechtigungen verwendet, Berechtigungen für diesen Vorgang erteilt. Sobald alle Werte festgelegt sind, sollte dies mit toString serialisiert und als Berechtigungsfeld für ein QueueSASSignatureValues-Objekt festgelegt werden. Es ist möglich, die Berechtigungszeichenfolge ohne diese Klasse zu erstellen, aber die Reihenfolge der Berechtigungen ist besonders, und diese Klasse garantiert die Richtigkeit.

Ein QueueServiceClient stellt eine URL zum Azure Storage-Warteschlangendienst dar, mit der Sie Warteschlangen bearbeiten können.

Ein benutzerdefinierter Fehlertyp für fehlerhafte Pipelineanforderungen.

Stellt die Komponenten dar, aus denen die Abfrageparameter einer Azure Storage-SAS bestehen. Dieser Typ wird nicht direkt vom Benutzer erstellt. sie wird nur von den Typen AccountSASSignatureValues und QueueSASSignatureValues generiert. Nach der Generierung kann es in eine toString() codiert und direkt an eine URL angefügt werden (obwohl hier Vorsicht geboten ist, falls Abfrageparameter vorhanden sind, die sich auf die geeignete Methode zum Anfügen dieser Abfrageparameter auswirken können).

HINWEIS: Instanzen dieser Klasse sind unveränderlich.

StorageBrowserPolicy behandelt Unterschiede zwischen Node.js und Browserlaufzeit, einschließlich:

1. Browser speichern GET/HEAD-Anforderungen zwischen, indem sie bedingte Header wie "IF_MODIFIED_SINCE" hinzufügen. StorageBrowserPolicy ist eine Richtlinie, die zum Hinzufügen einer Zeitstempelabfrage zur GET/HEAD-Anforderungs-URL verwendet wird, um den Browsercache zu vermeiden.

2. Entfernen des Cookieheaders aus Sicherheitsgründen

3. Entfernen des Inhaltslängenheaders, um Browserwarnungen zu vermeiden

StorageBrowserPolicyFactory ist eine Factoryklasse zum Generieren von StorageBrowserPolicy-Objekten.

Wiederholungsrichtlinie mit implementiertem exponentiellen Wiederholungs- und linearen Wiederholungsversuch.

StorageRetryPolicyFactory ist eine Factoryklasse, die beim Generieren von StorageRetryPolicy-Objekten hilft.

NUR IN NODE.JS RUNTIME VERFÜGBAR.

StorageSharedKeyCredential für die Kontoschlüsselautorisierung des Azure Storage-Diensts.

StorageSharedKeyCredentialPolicy ist eine Richtlinie, die zum Signieren einer HTTP-Anforderung mit einem freigegebenen Schlüssel verwendet wird.

Eine Zugriffsrichtlinie

NUR IN NODE.JS RUNTIME VERFÜGBAR.

AccountSASSignatureValues wird verwendet, um eine SAS (Shared Access Signature) für ein Azure Storage-Konto zu generieren. Nachdem alle werte hier entsprechend festgelegt wurden, rufen Sie generateSASQueryParameters() auf, um eine Darstellung der SAS zu erhalten, die tatsächlich auf Warteschlangen-URLs angewendet werden kann. Hinweis: Sowohl diese Klasse als auch SASQueryParameters sind vorhanden, da erstere veränderlich und eine logische Darstellung ist, während letztere unveränderlich ist und zum Generieren tatsächlicher REST-Anforderungen verwendet wird.

Weitere konzeptionelle Informationen zu SAS finden https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 Sie unter Beschreibungen https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas der Parameter, einschließlich der erforderlichen Parameter.

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.

CORS ist eine HTTP-Funktion, die einer Webanwendung in einer Domäne den Zugriff auf Ressourcen in einer anderen Domäne ermöglicht. Webbrowser implementieren eine Sicherheitseinschränkung, die als Richtlinie mit demselben Ursprung bezeichnet wird und verhindert, dass eine Webseite APIs in einer anderen Domäne aufruft. CORS bietet eine sichere Möglichkeit, es einer Domäne (der Ursprungsdomäne) zu ermöglichen, APIs in einer anderen Domäne aufzurufen.

Das Objekt, das im Array QueueMessageList zurückgegeben wird, wenn Nachrichten abrufen in einer Warteschlange aufgerufen wird.

Das Objekt, das im Array QueueMessageList zurückgegeben wird, wenn "Nachricht in einer Warteschlange" aufgerufen wird

Geo-Replication Informationen für den sekundären Speicherdienst

Eine Auflistung von Schlüssel-Wert-Paaren im HTTP-Header.

Http-Antwort, die mit core-v1(core-http) kompatibel ist.

Eine Darstellung einer HTTP-Antwort, die einen Verweis auf die Anforderung enthält, von der sie stammt.

Eine kompatible Schnittstelle für Core-HTTP-Anforderungsrichtlinien

Das Objekt, das beim Aufrufen von Listenwarteschlangen in einem Warteschlangendienst zurückgegeben wird.

Azure Analytics-Protokollierungseinstellungen.

Definiert Header für MessageId_delete Vorgang.

Definiert Header für MessageId_update Vorgang.

Definiert Header für Messages_clear Vorgang.

Definiert Header für Messages_dequeue Vorgang.

Optionale Parameter.

Definiert Header für Messages_enqueue Vorgang.

Optionale Parameter.

Definiert Header für Messages_peek Vorgang.

Optionale Parameter.

Eine Auflistung von Schlüssel-Wert-Zeichenfolgenpaaren.

Eine Schnittstelle, die Metriken darstellt.

Das Objekt, das beim Aufrufen von Peek-Nachrichten in einer Warteschlange im Array QueueMessageList zurückgegeben wird

Eine Schnittstelle für die Pipeline-Klasse , die HTTP-Anforderungsrichtlinien enthält. Sie können eine Standardpipeline erstellen, indem Sie newPipeline aufrufen. Alternativ können Sie eine Pipeline mit Ihren eigenen Richtlinien durch den Konstruktor von Pipeline erstellen.

Lesen Sie newPipeline und bereitgestellte Richtlinien, bevor Sie Ihre angepasste Pipeline implementieren.

Optionsschnittstelle für pipeline-Konstruktor.

Optionen zum Konfigurieren des clearMessages-Vorgangs

Definiert Header für Queue_create Vorgang.

Enthält Antwortdaten für den CreateIfNotExists-Vorgang .

Optionen zum Konfigurieren des Erstellungsvorgangs

Definiert Header für Queue_delete Vorgang.

Enthält Antwortdaten für den deleteIfExists-Vorgang .

Optionen zum Konfigurieren des deleteMessage-Vorgangs

Optionen zum Konfigurieren des Löschvorgangs

Optionen zum Konfigurieren vorhandener Vorgänge

Optionen zum Konfigurieren des GenerateSasUrl-Vorgangs .

Definiert Header für Queue_getAccessPolicy Vorgang.

Optionen zum Konfigurieren des getAccessPolicy-Vorgangs

Definiert Header für Queue_getProperties Vorgang.

Optionen zum Konfigurieren des getProperties-Vorgangs

Eine Azure Storage-Warteschlange.

Optionen zum Konfigurieren des PeekMessages-Vorgangs

Optionen zum Konfigurieren des Vorgangs "receiveMessages"

NUR IN NODE.JS RUNTIME VERFÜGBAR.

QueueSASSignatureValues wird verwendet, um warteschlangendienst-SAS-Token für Warteschlangen zu generieren.

Optionen zum Konfigurieren des sendMessage-Vorgangs

Eigenschaften des Speicherdiensts.

Statistiken für den Speicherdienst.

Definiert Header für Queue_setAccessPolicy Vorgang.

Optionen zum Konfigurieren des vorgangs setAccessPolicy

Definiert Header für Queue_setMetadata Vorgang.

Optionen zum Konfigurieren des vorgangs setMetadata

Optionen zum Konfigurieren des Vorgangs "updateMessage"

Eine Schnittstelle für die Kompatibilität mit der RequestPolicyFactory von core-http

Eine Schnittstelle für die Kompatibilität mit RequestPolicy

Ein Objekt mit einer einfachen _response-Eigenschaft.

Ein Objekt mit einer _response-Eigenschaft, deren Text und Header bereits in bekannte Typen analysiert wurden.

Ein -Objekt mit einer _response-Eigenschaft, deren Header bereits in ein typisiertes Objekt analysiert wurden.

Die Aufbewahrungsrichtlinie

Zulässiger IP-Bereich für eine SAS.

Eine Teilmenge von @azure/core-http ServiceClientOptions

Optionen zum Konfigurieren des GenerateAccountSasUrl-Vorgangs .

Definiert Header für Service_getProperties Vorgang.

Optionen zum Konfigurieren des getProperties-Vorgangs

Definiert Header für Service_getStatistics Vorgang.

Optionen zum Konfigurieren des getStatistics-Vorgangs

Optionen zum Konfigurieren des ListQueues-Vorgangs

Definiert Header für Service_listQueuesSegment Vorgang.

Definiert Header für Service_setProperties Vorgang.

Optionen zum Konfigurieren des SetProperties-Vorgangs

Signierter Bezeichner.

signierter Bezeichner

Optionsschnittstelle für die newPipeline-Funktion .

Schnittstelle für Speicherblob-Wiederholungsoptionen.

Eine Beschreibung einer HTTP-Anforderung, die an einen Remoteserver gestellt werden soll.

Eine Factoryfunktion, die eine neue CredentialPolicy erstellt, die die bereitgestellte nextPolicy verwendet.

Definiert Werte für GeoReplicationStatusType.

Typen von Textkörpern, die für die Anforderung unterstützt werden. NodeJS.ReadableStream und () => NodeJS.ReadableStream ist nur Node. Blob, ReadableStream und () => ReadableStream sind nur Browser.

Definiert Werte für ListQueuesIncludeType. Mögliche Werte: "Metadaten"

Enthält Antwortdaten für den Löschvorgang.

Enthält Antwortdaten für den Aktualisierungsvorgang.

Enthält Antwortdaten für den clear-Vorgang.

Enthält Antwortdaten für den clearMessages-Vorgang .

Enthält Antwortdaten für den Erstellungsvorgang.

Enthält Antwortdaten für den DeleteMessage-Vorgang .

Enthält Antwortdaten für den Löschvorgang.

Enthält Antwortdaten für den getAccessPolicy-Vorgang .

Enthält Antwortdaten für den getProperties-Vorgang.

Enthält die Antwortdaten für den peekMessages-Vorgang .

Enthält die Antwortdaten für den ReceiveMessages-Vorgang .

Enthält die Antwortdaten für den sendMessage-Vorgang .

Enthält Antwortdaten für den SetAccessPolicy-Vorgang.

Enthält Antwortdaten für den SetMetadata-Vorgang.

Enthält Antwortdaten für den UpdateMessage-Vorgang .

Das Objekt, das beim Aufrufen von receivedMessageItemsreceiveMessages im Array zurückgegeben wird.

Siehe: QueueReceiveMessageResponse

Enthält Antwortdaten für den getProperties-Vorgang.

Enthält Antwortdaten für den getStatistics-Vorgang.

Enthält Antwortdaten für den ListQueuesSegment-Vorgang.

Enthält Antwortdaten für den SetProperties-Vorgang.

Ein Typ, der ein Vorgangsergebnis mit einer bekannten _response-Eigenschaft darstellt.

Protokolle für generierte SAS.

Definiert die bekannten Cloudgruppen für Storage.

RetryPolicy-Typen.

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Generiert ein SASQueryParameters-Objekt , das alle SAS-Abfrageparameter enthält, die für eine tatsächliche REST-Anforderung erforderlich sind.

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

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Erstellt eine Instanz von SASQueryParameters.

Akzeptiert nur die erforderlichen Einstellungen, die zum Erstellen einer SAS erforderlich sind. Für optionale Einstellungen legen Sie die entsprechenden Eigenschaften direkt fest, z. B. Berechtigungen, StartsOn und Bezeichner.

WARNUNG: Wenn der Bezeichner nicht angegeben wird, sind Berechtigungen und ablaufendesOn erforderlich. Sie MÜSSEN dem Bezeichner einen Wert zuweisen oder ablaufenOn & Berechtigungen manuell, wenn Sie mit diesem Konstruktor initialisieren.

So rufen Sie die OAuth-Zielgruppe für ein Speicherkonto für den Warteschlangendienst ab.

Ein Helfer bei der Entscheidung, ob ein bestimmtes Argument den Pipelinevertrag erfüllt

Erstellt ein neues Pipelineobjekt mit bereitgestellten Anmeldeinformationen.