Freigeben über

@azure/storage-queue package

Klassen

AccountSASPermissions

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 <xref: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.
AccountSASResourceTypes

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 <xref: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.
AccountSASServices

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 <xref: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

AnonymousCredential stellt ein <xref:CredentialPolicyCreator> Mitglied bereit, das zum Erstellen von <xref:AnonymousCredentialPolicy> Objekten verwendet wird. <xref:AnonymousCredentialPolicy> wird mit HTTP(S)-Anforderungen verwendet, die öffentliche Ressourcen lesen oder für die Verwendung mit Shared Access Signatures (SAS) verwenden.
AnonymousCredentialPolicy

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

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

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

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. Verweisen Sie auf newPipeline() und bereitgestellte Richtlinien als Referenz, bevor Sie Ihre angepasste Pipeline implementieren.
QueueClient

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

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. Sobald alle Werte festgelegt wurden, sollte dies mit toString serialisiert und als Berechtigungsfeld für ein <xref: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.
QueueServiceClient

Ein QueueServiceClient stellt eine URL zum Azure Storage Queue-Dienst dar, mit dem Sie Warteschlangen bearbeiten können.
SASQueryParameters

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 <xref:AccountSASSignatureValues> und <xref:QueueSASSignatureValues> generiert. Nachdem sie generiert wurde, kann sie in eine <xref:String> 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

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

StorageBrowserPolicyFactory ist eine Factoryklasse, die <xref:StorageBrowserPolicy> Objekte generiert.
StorageClient

Ein StorageClient stellt eine basierte Clientklasse für <xref:QueueServiceClient>, <xref:QueueClient> und usw. dar.
StorageClientContext
StorageRetryPolicy

Wiederholungsrichtlinie mit exponentieller Wiederholung und linearer Wiederholung implementiert.
StorageRetryPolicyFactory

StorageRetryPolicyFactory ist eine Factoryklasse, die hilft, <xref:StorageRetryPolicy> Objekte zu generieren.
StorageSharedKeyCredential

NUR IN NODE.JS RUNTIME VERFÜGBAR. StorageSharedKeyCredential für die Kontoschlüsselautorisierung des Azure Storage-Diensts.
StorageSharedKeyCredentialPolicy

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

Schnittstellen

AccessPolicy

Eine Zugriffsrichtlinie
AccountSASSignatureValues

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 <xref:SASQueryParameters> vorhanden, da die erste Klasse änderbar und eine logische Darstellung ist, während letztere unveränderlich ist und zum Generieren tatsächlicher REST-Anforderungen verwendet wird.
CommonOptions

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

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

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

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

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

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

Azure Analytics-Protokollierungseinstellungen.
MessageIdDeleteHeaders

Definiert Kopfzeilen für MessageId_delete Vorgang.
MessageIdUpdateHeaders

Definiert Kopfzeilen für MessageId_update Vorgang.
MessagesClearHeaders

Definiert Kopfzeilen für Messages_clear Vorgang.
MessagesDequeueHeaders

Definiert Kopfzeilen für Messages_dequeue Vorgang.
MessagesDequeueOptionalParams

Optionale Parameter.
MessagesEnqueueHeaders

Definiert Kopfzeilen für Messages_enqueue Vorgang.
MessagesEnqueueOptionalParams

Optionale Parameter.
MessagesPeekHeaders

Definiert Kopfzeilen für Messages_peek Vorgang.
MessagesPeekOptionalParams

Optionale Parameter.
Metadata

Eine Auflistung von Schlüsselwert-Zeichenfolgenpaaren.
Metrics

Eine Schnittstelle, die Metriken darstellt.
PeekedMessageItem

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

Optionsschnittstelle für den Pipeline-Konstruktor.
QueueClearMessagesOptions

Optionen zum Konfigurieren <xref:QueueClient.clearMessages> Vorgangs
QueueCreateHeaders

Definiert Kopfzeilen für Queue_create Vorgang.
QueueCreateIfNotExistsResponse

Enthält Antwortdaten für den <xref:QueueClient.createIfNotExists> Vorgang.
QueueCreateOptions

Optionen zum Konfigurieren <xref:QueueClient.create> Vorgangs
QueueDeleteHeaders

Definiert Kopfzeilen für Queue_delete Vorgang.
QueueDeleteIfExistsResponse

Enthält Antwortdaten für den <xref:QueueClient.deleteIfExists> Vorgang.
QueueDeleteMessageOptions

Optionen zum Konfigurieren des <xref:QueueClient.deleteMessage>-Vorgangs
QueueDeleteOptions

Optionen zum Konfigurieren <xref:QueueClient.delete> Vorgangs
QueueExistsOptions

Optionen zum Konfigurieren <xref:QueueClient.exists> Vorgangs
QueueGenerateSasUrlOptions

Optionen zum Konfigurieren <xref:QueueClient.generateSasUrl> Vorgangs.
QueueGetAccessPolicyHeaders

Definiert Kopfzeilen für Queue_getAccessPolicy Vorgang.
QueueGetAccessPolicyOptions

Optionen zum Konfigurieren <xref:QueueClient.getAccessPolicy> Vorgangs
QueueGetPropertiesHeaders

Definiert Kopfzeilen für Queue_getProperties Vorgang.
QueueGetPropertiesOptions

Optionen zum Konfigurieren <xref:QueueClient.getProperties> Vorgangs
QueueItem

Eine Azure Storage-Warteschlange.
QueuePeekMessagesOptions

Optionen zum Konfigurieren <xref:QueueClient.peekMessages> Vorgangs
QueueReceiveMessageOptions

Optionen zum Konfigurieren <xref:QueueClient.receiveMessages> Vorgangs
QueueSASSignatureValues

NUR IN NODE.JS RUNTIME VERFÜGBAR. QueueSASSignatureValues wird verwendet, um das Generieren von SAS-Token des Warteschlangendiensts für Warteschlangen zu unterstützen.
QueueSendMessageOptions

Optionen zum Konfigurieren <xref:QueueClient.sendMessage> Vorgangs
QueueServiceProperties

Speicherdiensteigenschaften.
QueueServiceStatistics

Statistiken für den Speicherdienst.
QueueSetAccessPolicyHeaders

Definiert Kopfzeilen für Queue_setAccessPolicy Vorgang.
QueueSetAccessPolicyOptions

Optionen zum Konfigurieren <xref:QueueClient.setAccessPolicy> Vorgangs
QueueSetMetadataHeaders

Definiert Kopfzeilen für Queue_setMetadata Vorgang.
QueueSetMetadataOptions

Optionen zum Konfigurieren <xref:QueueClient.setMetadata> Vorgangs
QueueUpdateMessageOptions

Optionen zum Konfigurieren <xref:QueueClient.updateMessage> Vorgangs
RetentionPolicy

die Aufbewahrungsrichtlinie
SasIPRange

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

Optionen zum Konfigurieren <xref:QueueServiceClient.generateAccountSasUrl> Vorgangs.
ServiceGetPropertiesHeaders

Definiert Kopfzeilen für Service_getProperties Vorgang.
ServiceGetPropertiesOptions

Optionen zum Konfigurieren <xref:QueueServiceClient.getProperties> Vorgangs
ServiceGetStatisticsHeaders

Definiert Kopfzeilen für Service_getStatistics Vorgang.
ServiceGetStatisticsOptions

Optionen zum Konfigurieren <xref:QueueServiceClient.getStatistics> Vorgangs
ServiceListQueuesOptions

Optionen zum Konfigurieren <xref:QueueServiceClient.listQueues> Vorgangs
ServiceListQueuesSegmentHeaders

Definiert Kopfzeilen für Service_listQueuesSegment Vorgang.
ServiceSetPropertiesHeaders

Definiert Kopfzeilen für Service_setProperties Vorgang.
ServiceSetPropertiesOptions

Optionen zum Konfigurieren <xref:QueueServiceClient.setProperties> Vorgangs
SignedIdentifier

Signierter Bezeichner.
SignedIdentifierModel

Signierter Bezeichner
StorageClientOptionalParams

Optionale Parameter.
StoragePipelineOptions

Optionsschnittstelle für die Methode newPipeline().
StorageRetryOptions

Benutzeroberfläche für Speicherwarteschlangen-Wiederholungsoptionen.

Typaliase

CredentialPolicyCreator

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

Definiert Werte für GeoReplicationStatusType.
ListQueuesIncludeType

Definiert Werte für ListQueuesIncludeType. Mögliche Werte sind: 'Metadaten'
MessageIdDeleteResponse

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

Enthält Antwortdaten für den Aktualisierungsvorgang.
MessagesClearResponse

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

Enthält Antwortdaten für den <xref:QueueClient.clearMessages> Vorgang.
QueueCreateResponse

Enthält Antwortdaten für den Erstellungsvorgang.
QueueDeleteMessageResponse

Enthält Antwortdaten für den <xref:QueueClient.deleteMessage> Vorgang.
QueueDeleteResponse

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

Enthält Antwortdaten für den <xref:QueueClient.getAccessPolicy> Vorgang.
QueueGetPropertiesResponse

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

Enthält die Antwortdaten für den <xref:QueueClient.peekMessages> Vorgang.
QueueReceiveMessageResponse

Enthält die Antwortdaten für den <xref:QueueClient.receiveMessages> Vorgang.
QueueSendMessageResponse

Enthält die Antwortdaten für den <xref:QueueClient.sendMessage> Vorgang.
QueueSetAccessPolicyResponse

Enthält Antwortdaten für den setAccessPolicy-Vorgang.
QueueSetMetadataResponse

Enthält Antwortdaten für den setMetadata-Vorgang.
QueueUpdateMessageResponse

Enthält Antwortdaten für den <xref:QueueClient.updateMessage> Vorgang.
ReceivedMessageItem

Das objekt, das beim Aufrufen von receivedMessageItemsim <xref:QueueClient.receiveMessages> Array zurückgegeben wird. Siehe: <xref:QueueReceiveMessageResponse>
ServiceGetPropertiesResponse

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

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

Enthält Antwortdaten für den listQueuesSegment-Vorgang.
ServiceSetPropertiesResponse

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

Enumerationen

SASProtocol

Protokolle für generierte SAS.
StorageRetryPolicyType

RetryPolicy-Typen.

Functions

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

NUR IN NODE.JS RUNTIME VERFÜGBAR. Generiert ein <xref:SASQueryParameters> -Objekt, das alle SAS-Abfrageparameter enthält, die zum Erstellen einer tatsächlichen REST-Anforderung erforderlich sind.
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

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.
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Erstellt ein neues Pipelineobjekt mit bereitgestellten Anmeldeinformationen.

Details zur Funktion

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

NUR IN NODE.JS RUNTIME VERFÜGBAR. Generiert ein <xref:SASQueryParameters> -Objekt, das alle SAS-Abfrageparameter enthält, die zum Erstellen einer tatsächlichen REST-Anforderung erforderlich sind.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parameter

accountSASSignatureValues
AccountSASSignatureValues

SAS-Signaturwerte des Kontos

sharedKeyCredential
StorageSharedKeyCredential

Freigegebene Schlüsselanmeldeinformationen.

Gibt zurück

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

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.

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parameter

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Gibt zurück

SASQueryParameters

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Erstellt ein neues Pipelineobjekt mit bereitgestellten Anmeldeinformationen.

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

Parameter

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity-Paket zum Authentifizieren von Anforderungen an den Dienst. Sie können auch ein Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

pipelineOptions
StoragePipelineOptions

Optionen.

Gibt zurück

Pipeline

Ein neues Pipelineobjekt.