@azure/storage-queue package

Klassen

AccountSASPermissions	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.
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. 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.
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 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	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	AnonymousCredentialPolicy wird mit HTTP(S)-Anforderungen verwendet, die öffentliche Ressourcen lesen, oder für die Verwendung mit Shared Access Signatures (SAS).
BaseRequestPolicy	Die Basisklasse, von der alle Anforderungsrichtlinien abgeleitet werden.
Credential	Anmeldeinformationen sind eine abstrakte Klasse für die Signatur von HTTP-Anforderungen in Azure Storage. Diese Klasse hostt eine credentialPolicyCreator-Factory, die CredentialPolicy generiert.
CredentialPolicy	Anmeldeinformationsrichtlinie, die zum Signieren von HTTP(S)-Anforderungen vor dem Senden verwendet wird. Dies ist eine abstrakte Klasse.
Pipeline	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.
QueueClient	Ein QueueClient stellt eine URL zu den Nachrichten einer Azure Storage-Warteschlange dar, mit der Sie deren Nachrichten bearbeiten können.
QueueSASPermissions	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.
QueueServiceClient	Ein QueueServiceClient stellt eine URL zum Azure Storage-Warteschlangendienst dar, mit der Sie Warteschlangen bearbeiten können.
RestError	Ein benutzerdefinierter Fehlertyp für fehlerhafte Pipelineanforderungen.
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 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	StorageBrowserPolicy behandelt Unterschiede zwischen Node.js und Browserlaufzeit, einschließlich: 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. Entfernen des Cookieheaders aus Sicherheitsgründen Entfernen des Inhaltslängenheaders, um Browserwarnungen zu vermeiden
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory ist eine Factoryklasse zum Generieren von StorageBrowserPolicy-Objekten.
StorageRetryPolicy	Wiederholungsrichtlinie mit implementiertem exponentiellen Wiederholungs- und linearen Wiederholungsversuch.
StorageRetryPolicyFactory	StorageRetryPolicyFactory ist eine Factoryklasse, die beim Generieren von StorageRetryPolicy-Objekten hilft.
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 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.
CommonOptions	Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
CorsRule	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.
DequeuedMessageItem	Das Objekt, das im Array QueueMessageList zurückgegeben wird, wenn Nachrichten abrufen in einer Warteschlange aufgerufen wird.
EnqueuedMessage	Das Objekt, das im Array QueueMessageList zurückgegeben wird, wenn "Nachricht in einer Warteschlange" aufgerufen wird
GeoReplication	Geo-Replication Informationen für den sekundären Speicherdienst
HttpHeaders	Eine Auflistung von Schlüssel-Wert-Paaren im HTTP-Header.
HttpOperationResponse	Http-Antwort, die mit core-v1(core-http) kompatibel ist.
HttpResponse	Eine Darstellung einer HTTP-Antwort, die einen Verweis auf die Anforderung enthält, von der sie stammt.
IHttpClient	Eine kompatible Schnittstelle für Core-HTTP-Anforderungsrichtlinien
ListQueuesSegmentResponse	Das Objekt, das beim Aufrufen von Listenwarteschlangen in einem Warteschlangendienst zurückgegeben wird.
Logging	Azure Analytics-Protokollierungseinstellungen.
MessageIdDeleteHeaders	Definiert Header für MessageId_delete Vorgang.
MessageIdUpdateHeaders	Definiert Header für MessageId_update Vorgang.
MessagesClearHeaders	Definiert Header für Messages_clear Vorgang.
MessagesDequeueHeaders	Definiert Header für Messages_dequeue Vorgang.
MessagesDequeueOptionalParams	Optionale Parameter.
MessagesEnqueueHeaders	Definiert Header für Messages_enqueue Vorgang.
MessagesEnqueueOptionalParams	Optionale Parameter.
MessagesPeekHeaders	Definiert Header für Messages_peek Vorgang.
MessagesPeekOptionalParams	Optionale Parameter.
Metadata	Eine Auflistung von Schlüssel-Wert-Zeichenfolgenpaaren.
Metrics	Eine Schnittstelle, die Metriken darstellt.
PeekedMessageItem	Das Objekt, das beim Aufrufen von Peek-Nachrichten in einer Warteschlange im Array QueueMessageList zurückgegeben wird
PipelineLike	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.
PipelineOptions	Optionsschnittstelle für pipeline-Konstruktor.
QueueClearMessagesOptions	Optionen zum Konfigurieren des clearMessages-Vorgangs
QueueCreateHeaders	Definiert Header für Queue_create Vorgang.
QueueCreateIfNotExistsResponse	Enthält Antwortdaten für den CreateIfNotExists-Vorgang .
QueueCreateOptions	Optionen zum Konfigurieren des Erstellungsvorgangs
QueueDeleteHeaders	Definiert Header für Queue_delete Vorgang.
QueueDeleteIfExistsResponse	Enthält Antwortdaten für den deleteIfExists-Vorgang .
QueueDeleteMessageOptions	Optionen zum Konfigurieren des deleteMessage-Vorgangs
QueueDeleteOptions	Optionen zum Konfigurieren des Löschvorgangs
QueueExistsOptions	Optionen zum Konfigurieren vorhandener Vorgänge
QueueGenerateSasUrlOptions	Optionen zum Konfigurieren des GenerateSasUrl-Vorgangs .
QueueGetAccessPolicyHeaders	Definiert Header für Queue_getAccessPolicy Vorgang.
QueueGetAccessPolicyOptions	Optionen zum Konfigurieren des getAccessPolicy-Vorgangs
QueueGetPropertiesHeaders	Definiert Header für Queue_getProperties Vorgang.
QueueGetPropertiesOptions	Optionen zum Konfigurieren des getProperties-Vorgangs
QueueItem	Eine Azure Storage-Warteschlange.
QueuePeekMessagesOptions	Optionen zum Konfigurieren des PeekMessages-Vorgangs
QueueReceiveMessageOptions	Optionen zum Konfigurieren des Vorgangs "receiveMessages"
QueueSASSignatureValues	NUR IN NODE.JS RUNTIME VERFÜGBAR. QueueSASSignatureValues wird verwendet, um warteschlangendienst-SAS-Token für Warteschlangen zu generieren.
QueueSendMessageOptions	Optionen zum Konfigurieren des sendMessage-Vorgangs
QueueServiceProperties	Eigenschaften des Speicherdiensts.
QueueServiceStatistics	Statistiken für den Speicherdienst.
QueueSetAccessPolicyHeaders	Definiert Header für Queue_setAccessPolicy Vorgang.
QueueSetAccessPolicyOptions	Optionen zum Konfigurieren des vorgangs setAccessPolicy
QueueSetMetadataHeaders	Definiert Header für Queue_setMetadata Vorgang.
QueueSetMetadataOptions	Optionen zum Konfigurieren des vorgangs setMetadata
QueueUpdateMessageOptions	Optionen zum Konfigurieren des Vorgangs "updateMessage"
RequestPolicyFactory	Eine Schnittstelle für die Kompatibilität mit der RequestPolicyFactory von core-http
RequestPolicyOptions	Eine Schnittstelle für die Kompatibilität mit RequestPolicy
ResponseLike	Ein Objekt mit einer einfachen _response-Eigenschaft.
ResponseWithBody	Ein Objekt mit einer _response-Eigenschaft, deren Text und Header bereits in bekannte Typen analysiert wurden.
ResponseWithHeaders	Ein -Objekt mit einer _response-Eigenschaft, deren Header bereits in ein typisiertes Objekt analysiert wurden.
RetentionPolicy	Die Aufbewahrungsrichtlinie
SasIPRange	Zulässiger IP-Bereich für eine SAS.
ServiceClientOptions	Eine Teilmenge von @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Optionen zum Konfigurieren des GenerateAccountSasUrl-Vorgangs .
ServiceGetPropertiesHeaders	Definiert Header für Service_getProperties Vorgang.
ServiceGetPropertiesOptions	Optionen zum Konfigurieren des getProperties-Vorgangs
ServiceGetStatisticsHeaders	Definiert Header für Service_getStatistics Vorgang.
ServiceGetStatisticsOptions	Optionen zum Konfigurieren des getStatistics-Vorgangs
ServiceListQueuesOptions	Optionen zum Konfigurieren des ListQueues-Vorgangs
ServiceListQueuesSegmentHeaders	Definiert Header für Service_listQueuesSegment Vorgang.
ServiceSetPropertiesHeaders	Definiert Header für Service_setProperties Vorgang.
ServiceSetPropertiesOptions	Optionen zum Konfigurieren des SetProperties-Vorgangs
SignedIdentifier	Signierter Bezeichner.
SignedIdentifierModel	signierter Bezeichner
StoragePipelineOptions	Optionsschnittstelle für die newPipeline-Funktion .
StorageRetryOptions	Schnittstelle für Speicherblob-Wiederholungsoptionen.
WebResource	Eine Beschreibung einer HTTP-Anforderung, die an einen Remoteserver gestellt werden soll.

Typaliase

CredentialPolicyCreator	Eine Factoryfunktion, die eine neue CredentialPolicy erstellt, die die bereitgestellte nextPolicy verwendet.
GeoReplicationStatusType	Definiert Werte für GeoReplicationStatusType.
HttpRequestBody	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.
ListQueuesIncludeType	Definiert Werte für ListQueuesIncludeType. Mögliche Werte: "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 clearMessages-Vorgang .
QueueCreateResponse	Enthält Antwortdaten für den Erstellungsvorgang.
QueueDeleteMessageResponse	Enthält Antwortdaten für den DeleteMessage-Vorgang .
QueueDeleteResponse	Enthält Antwortdaten für den Löschvorgang.
QueueGetAccessPolicyResponse	Enthält Antwortdaten für den getAccessPolicy-Vorgang .
QueueGetPropertiesResponse	Enthält Antwortdaten für den getProperties-Vorgang.
QueuePeekMessagesResponse	Enthält die Antwortdaten für den peekMessages-Vorgang .
QueueReceiveMessageResponse	Enthält die Antwortdaten für den ReceiveMessages-Vorgang .
QueueSendMessageResponse	Enthält die Antwortdaten für den 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 UpdateMessage-Vorgang .
ReceivedMessageItem	Das Objekt, das beim Aufrufen von receivedMessageItemsreceiveMessages im Array zurückgegeben wird. Siehe: 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.
WithResponse	Ein Typ, der ein Vorgangsergebnis mit einer bekannten _response-Eigenschaft darstellt.

Enumerationen

SASProtocol	Protokolle für generierte SAS.
StorageQueueAudience	Definiert die bekannten Cloudgruppen für Storage.
StorageRetryPolicyType	RetryPolicy-Typen.

Functions

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	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.
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)	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.
getQueueServiceAccountAudience(string)	So rufen Sie die OAuth-Zielgruppe für ein Speicherkonto für den Warteschlangendienst ab.
isPipelineLike(unknown)	Ein Helfer bei der Entscheidung, ob ein bestimmtes Argument den Pipelinevertrag erfüllt
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 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.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parameter

accountSASSignatureValues

AccountSASSignatureValues

SAS-Signaturwerte des Kontos

sharedKeyCredential

StorageSharedKeyCredential

Anmeldeinformationen für freigegebene Schlüssel.

Gibt zurück

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

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.

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

Parameter

queueSASSignatureValues

QueueSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

Gibt zurück

SASQueryParameters

getQueueServiceAccountAudience(string)

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

function getQueueServiceAccountAudience(storageAccountName: string): string

Parameter

storageAccountName

string

Gibt zurück

string

isPipelineLike(unknown)

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

function isPipelineLike(pipeline: unknown): pipeline

Parameter

pipeline

unknown

Ein Argument, das eine Pipeline sein kann

Gibt zurück

pipeline

TRUE, wenn das Argument den Pipelinevertrag erfüllt

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Erstellt ein neues Pipelineobjekt mit bereitgestellten Anmeldeinformationen.

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

Parameter

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Beispielsweise AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

pipelineOptions

StoragePipelineOptions

Optional. Optionen.

Gibt zurück

Pipeline

Ein neues Pipelineobjekt.