@azure/storage-queue package

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse, um eine Zeichenfolge zu erstellen, die die von einem AccountSAS gewährten Berechtigungen darstellt. Das Festlegen eines Werts auf "true" bedeutet, dass jeder SAS, der diese Berechtigungen verwendet, Berechtigungen für diesen Vorgang erteilt. Nachdem alle Werte festgelegt wurden, 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. Nachdem alle Werte festgelegt wurden, 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 Korrektheit.

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 jeder SAS, der diese Berechtigungen verwendet, Zugriff auf diesen Dienst gewährt. Nachdem alle Werte festgelegt wurden, 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-Mitglied 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) verwenden.

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

Die Basisklasse, von der alle Anforderungsrichtlinien abgeleitet werden.

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

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

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

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

Ein QueueClient stellt eine URL zu den Nachrichten einer Azure Storage-Warteschlange dar, mit denen Sie die zugehörigen Nachrichten bearbeiten können.

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse, um eine Zeichenfolge zu erstellen, die die Von einem ServiceSAS für eine Warteschlange gewährten Berechtigungen darstellt. Das Festlegen eines Werts auf "true" bedeutet, dass jeder SAS, der diese Berechtigungen verwendet, Berechtigungen für diesen Vorgang erteilt. Nachdem alle Werte festgelegt wurden, 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 Queue-Dienst dar, mit dem Sie Warteschlangen bearbeiten können.

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene 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 AccountSASSignatureValues und QueueSASSignatureValues Typen generiert. Nachdem sie generiert wurde, kann sie in eine toString() codiert und direkt an eine URL angefügt werden (allerdings sollten Sie hier vorsichtig sein, falls es vorhandene Abfrageparameter gibt, die sich auf die geeigneten Methoden 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 verwendet wird, um eine Zeitstempelabfrage zur GET/HEAD-Anforderungs-URL hinzuzufügen, wodurch der Browsercache vermieden wird.

2. Entfernen des Cookieheaders zur Sicherheit

3. Entfernen des Headers mit Inhaltslänge, um Browserwarnungen zu vermeiden

StorageBrowserPolicyFactory ist eine Factoryklasse, die das Generieren von StorageBrowserPolicy-Objekten unterstützt.

Wiederholungsrichtlinie mit exponentieller Wiederholung und linearer Wiederholung implementiert.

StorageRetryPolicyFactory ist eine Factoryklasse, die StorageRetryPolicy--Objekte generiert.

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 Freigegebene Zugriffssignatur (SAS) für ein Azure Storage-Konto zu generieren. Nachdem alle hier aufgeführten Werte entsprechend festgelegt wurden, rufen Sie generateSASQueryParameters() auf, um eine Darstellung des SAS abzurufen, die tatsächlich auf Warteschlangen-URLs angewendet werden kann. Hinweis: Sowohl diese Klasse als auch SASQueryParameters vorhanden, da der frühere Wert änderbar 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 Sie unter https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 Unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas finden Sie Beschreibungen der Parameter, einschließlich der erforderlichen Parameter.

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

CORS ist ein HTTP-Feature, mit dem eine Webanwendung, die unter einer Domäne ausgeführt wird, auf Ressourcen in einer anderen Domäne zugreifen kann. Webbrowser implementieren eine Sicherheitseinschränkung, die als Richtlinie für denselben Ursprung bezeichnet wird, die verhindert, dass eine Webseite APIs in einer anderen Domäne aufruft; CORS bietet eine sichere Möglichkeit, eine Domäne (die Ursprungsdomäne) zum Aufrufen von APIs in einer anderen Domäne zuzulassen.

Das objekt, das beim Aufrufen von "Nachrichten in einer Warteschlange" im QueueMessageList-Array zurückgegeben wird.

Das objekt, das beim Aufrufen von Put Message in einer Warteschlange im QueueMessageList-Array zurückgegeben wird

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

Eine Sammlung von HTTP-Headerschlüssel-Wert-Paaren.

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

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

Eine kompatible Schnittstelle für Kern-HTTP-Anforderungsrichtlinien

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

Azure Analytics-Protokollierungseinstellungen.

Definiert Kopfzeilen für MessageId_delete Vorgang.

Definiert Kopfzeilen für MessageId_update Vorgang.

Definiert Kopfzeilen für Messages_clear Vorgang.

Definiert Kopfzeilen für Messages_dequeue Vorgang.

Optionale Parameter.

Definiert Kopfzeilen für Messages_enqueue Vorgang.

Optionale Parameter.

Definiert Kopfzeilen für Messages_peek Vorgang.

Optionale Parameter.

Eine Auflistung von Schlüsselwert-Zeichenfolgenpaaren.

Eine Schnittstelle, die Metriken darstellt.

Das objekt, das beim Aufrufen von Vorschaunachrichten in einer Warteschlange im QueueMessageList-Array 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. Oder Sie können eine Pipeline mit Ihren eigenen Richtlinien durch den Konstruktor von Pipeline erstellen.

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

Option interface for Pipeline constructor.

Optionen zum Konfigurieren clearMessages Vorgangs

Definiert Kopfzeilen für Queue_create Vorgang.

Enthält Antwortdaten für den createIfNotExists Vorgang.

Optionen zum Konfigurieren Erstellen Vorgangs

Definiert Kopfzeilen für Queue_delete Vorgang.

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

Optionen zum Konfigurieren des deleteMessage--Vorgangs

Optionen zum Konfigurieren Löschen Vorgangs

Optionen zum Konfigurieren von sind Vorgang vorhanden.

Optionen zum Konfigurieren generateSasUrl Vorgangs.

Definiert Kopfzeilen für Queue_getAccessPolicy Vorgang.

Optionen zum Konfigurieren getAccessPolicy Vorgangs

Definiert Kopfzeilen für Queue_getProperties Vorgang.

Optionen zum Konfigurieren getProperties Vorgangs

Eine Azure Storage-Warteschlange.

Optionen zum Konfigurieren peekMessages Vorgangs

Optionen zum Konfigurieren receiveMessages Vorgangs

NUR IN NODE.JS RUNTIME VERFÜGBAR.

QueueSASSignatureValues wird verwendet, um das Generieren von SAS-Token des Warteschlangendiensts für Warteschlangen zu unterstützen.

Optionen zum Konfigurieren sendMessage- Vorgangs

Speicherdiensteigenschaften.

Statistiken für den Speicherdienst.

Definiert Kopfzeilen für Queue_setAccessPolicy Vorgang.

Optionen zum Konfigurieren setAccessPolicy Vorgangs

Definiert Kopfzeilen für Queue_setMetadata Vorgang.

Optionen zum Konfigurieren setMetadata- Vorgangs

Optionen zum Konfigurieren updateMessage- Vorgangs

Eine Schnittstelle zur Kompatibilität mit der RequestPolicyFactory von Core-http

Eine Schnittstelle zur Kompatibilität mit RequestPolicy

Ein Objekt mit einer einfachen _response-Eigenschaft.

Ein Objekt mit einer _response Eigenschaft mit Textkörper und Kopfzeilen, die bereits in bekannte Typen analysiert wurden.

Ein Objekt mit einer _response-Eigenschaft, die bereits in ein typiertes Objekt analysiert wurde.

die Aufbewahrungsrichtlinie

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

Eine Teilmenge von @azure/core-http ServiceClientOptions

Optionen zum Konfigurieren generateAccountSasUrl Vorgangs.

Definiert Kopfzeilen für Service_getProperties Vorgang.

Optionen zum Konfigurieren getProperties Vorgangs

Definiert Kopfzeilen für Service_getStatistics Vorgang.

Optionen zum Konfigurieren getStatistics--Vorgangs

Optionen zum Konfigurieren listQueues Vorgangs

Definiert Kopfzeilen für Service_listQueuesSegment Vorgang.

Definiert Kopfzeilen für Service_setProperties Vorgang.

Optionen zum Konfigurieren setProperties Vorgangs

Signierter Bezeichner.

Signierter Bezeichner

Optionsschnittstelle für die newPipeline--Funktion.

Speicher-BLOB-Wiederholungsoptionenschnittstelle.

Eine Beschreibung einer HTTP-Anforderung, die an einem Remoteserver gesendet werden soll.

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

Definiert Werte für GeoReplicationStatusType.

Typen von Textkörpern, die auf der 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 sind: '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 receiveMessagesim receivedMessageItems 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 den Speicher.

RetryPolicy-Typen.

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Generiert ein SASQueryParameters- -Objekt, das alle SAS-Abfrageparameter enthält, die zum Erstellen einer tatsächlichen 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 erforderliche 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 AblaufenOn 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, der entscheidet, ob ein bestimmtes Argument dem Pipelinevertrag entspricht.

Erstellt ein neues Pipelineobjekt mit bereitgestellten Anmeldeinformationen.