@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. |
HttpHeaders |
Eine Auflistung von Schlüssel-Wert-Paaren im HTTP-Header. |
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 als Referenz, 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 einer Warteschlange von einem ServiceSAS erteilt werden. Das Festlegen eines Werts auf true bedeutet, dass jede SAS, die 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. |
QueueServiceClient |
Ein QueueServiceClient stellt eine URL zum Azure Storage-Warteschlangendienst dar, mit der Sie Warteschlangen bearbeiten können. |
RequestPolicyOptions |
Optionale Eigenschaften, die beim Erstellen einer RequestPolicy verwendet werden können. |
RestError |
Ein Fehler, der sich aus einer HTTP-Anforderung an einen Dienstendpunkt ergibt. |
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 (wobei hier Vorsicht geboten ist, wenn abfrageparameter vorhanden sind, was sich auf die geeignete Methode zum Anfügen dieser Abfrageparameter auswirken kann). HINWEIS: Instanzen dieser Klasse sind unveränderlich. |
StorageBrowserPolicy |
StorageBrowserPolicy behandelt Unterschiede zwischen Node.js und Browserruntime, einschließlich:
|
StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory ist eine Factoryklasse, die beim Generieren von StorageBrowserPolicy-Objekten hilft. |
StorageRetryPolicy |
Wiederholungsrichtlinie mit implementierter exponentieller Wiederholung und linearer Wiederholung. |
StorageRetryPolicyFactory |
StorageRetryPolicyFactory ist eine Factoryklasse, die das Generieren von StorageRetryPolicy-Objekten unterstützt. |
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 von HTTP-Anforderungen mit einem freigegebenen Schlüssel verwendet wird. |
WebResource |
Erstellt ein neues WebResource-Objekt. Diese Klasse stellt eine Abstraktion über einen REST-Aufruf bereit, indem sie bibliotheks-/implementierungsunabhängig ist und die erforderlichen Eigenschaften umschlossen, um eine Anforderung zu initiieren. |
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 |
HttpOperationResponse |
Wrapperobjekt für HTTP-Anforderung und -Antwort. Das deserialisierte Objekt wird in der |
IHttpClient |
Eine Schnittstelle, die HttpRequests senden und zugesagte HttpResponses empfangen kann. |
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 im Array QueueMessageList zurückgegeben wird, wenn Peek Nachrichten in einer Warteschlange aufgerufen werden |
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 des Vorgangs exists |
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 receiveMessages-Vorgangs |
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 setAccessPolicy-Vorgangs |
QueueSetMetadataHeaders |
Definiert Header für Queue_setMetadata Vorgang. |
QueueSetMetadataOptions |
Optionen zum Konfigurieren des setMetadata-Vorgangs |
QueueUpdateMessageOptions |
Optionen zum Konfigurieren des UpdateMessage-Vorgangs |
RequestPolicy |
Die zugrunde liegende Struktur einer Anforderungsrichtlinie. |
RetentionPolicy |
Die Aufbewahrungsrichtlinie |
SasIPRange |
Zulässiger IP-Bereich für eine SAS. |
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()-Methode. |
StorageRetryOptions |
Schnittstelle für Speicherwarteschlangen-Wiederholungsoptionen. |
Typaliase
CredentialPolicyCreator |
Eine Factoryfunktion, die eine neue CredentialPolicy erstellt, die die bereitgestellte nextPolicy verwendet. |
GeoReplicationStatusType |
Definiert Werte für GeoReplicationStatusType. |
HttpRequestBody |
Mögliche HTTP-Anforderungstexttypen |
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 Siehe: QueueReceiveMessageResponse |
RequestPolicyFactory |
Erstellt eine neue RequestPolicy pro Anforderung, die die bereitgestellte nextPolicy verwendet. |
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. |
StorageQueueAudience |
Definiert die bekannten Cloudgruppen für Storage. |
StorageRetryPolicyType |
RetryPolicy-Typen. |
Functions
deserialization |
Erstellen Sie eine neue Serialisierung RequestPolicyCreator, die HTTP-Anforderungstexte serialisiert, während sie die HTTP-Pipeline durchlaufen. |
generate |
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. |
generate |
NUR IN NODE.JS RUNTIME VERFÜGBAR. Erstellt eine instance von SASQueryParameters. Akzeptiert nur die erforderlichen Einstellungen, die zum Erstellen einer SAS erforderlich sind. Legen Sie für optionale Einstellungen die entsprechenden Eigenschaften wie berechtigungen, startsOn und identifier direkt fest. WARNUNG: Wenn der Bezeichner nicht angegeben wird, sind Berechtigungen und Ablauf erforderlich. Sie MÜSSEN dem Bezeichner einen Wert zuweisen oder ablaufenOn & Berechtigungen manuell, wenn Sie mit diesem Konstruktor initialisieren. |
get |
|
new |
Erstellt ein neues Pipelineobjekt mit bereitgestellten Anmeldeinformationen. |
Details zur Funktion
deserializationPolicy(DeserializationContentTypes, SerializerOptions)
Erstellen Sie eine neue Serialisierung RequestPolicyCreator, die HTTP-Anforderungstexte serialisiert, während sie die HTTP-Pipeline durchlaufen.
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory
Parameter
- deserializationContentTypes
- DeserializationContentTypes
- parsingOptions
- SerializerOptions
Gibt zurück
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 gemeinsam genutzte Schlüssel.
Gibt zurück
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)
NUR IN NODE.JS RUNTIME VERFÜGBAR.
Erstellt eine instance von SASQueryParameters.
Akzeptiert nur die erforderlichen Einstellungen, die zum Erstellen einer SAS erforderlich sind. Legen Sie für optionale Einstellungen die entsprechenden Eigenschaften wie berechtigungen, startsOn und identifier direkt fest.
WARNUNG: Wenn der Bezeichner nicht angegeben wird, sind Berechtigungen und Ablauf 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
getQueueServiceAccountAudience(string)
function getQueueServiceAccountAudience(storageAccountName: string): string
Parameter
- storageAccountName
-
string
Gibt zurück
string
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
Optionen.
Gibt zurück
Ein neues Pipelineobjekt.