@azure/storage-blob package

  • Referenz

Klassen

AccountSASPermissions

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die von einem AccountSAS erteilten Berechtigungen darstellt. 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 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 diese 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-Element 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).
AppendBlobClient

AppendBlobClient definiert eine Reihe von Vorgängen, die für das Anfügen von Blobs gelten.
BaseRequestPolicy

Die Basisklasse, von der alle Anforderungsrichtlinien abgeleitet werden.
BlobBatch

Ein BlobBatch stellt einen aggregierten Satz von Vorgängen für Blobs dar. Derzeit werden nur delete und setAccessTier unterstützt.
BlobBatchClient

Mit einem BlobBatchClient können Sie Batchanforderungen an den Azure Storage-Blobdienst senden.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch.
BlobClient

Ein BlobClient stellt eine URL zu einem Azure Storage-Blob dar. Das Blob kann ein Blockblob, ein Anfügeblob oder ein Seitenblob sein.
BlobLeaseClient

Ein Client, der Leases für einen ContainerClient oder einen BlobClient verwaltet.
BlobSASPermissions

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die Berechtigungen darstellt, die einem Blob 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 BlobSASSignatureValues-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.
BlobServiceClient

Ein BlobServiceClient stellt einen Client für den Azure Storage-Blobdienst dar, mit dem Sie Blobcontainer bearbeiten können.
BlockBlobClient

BlockBlobClient definiert eine Reihe von Vorgängen, die für Blockblobs gelten.
ContainerClient

Ein ContainerClient stellt eine URL zum Azure Storage-Container dar, mit der Sie dessen Blobs bearbeiten können.
ContainerSASPermissions

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die Berechtigungen darstellt, die einem Container 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 BlobSASSignatureValues-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.
Credential

Credential ist eine abstrakte Klasse für die Signierung von HTTP-Anforderungen in Azure Storage. 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.
HttpHeaders

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

PageBlobClient definiert eine Reihe von Vorgängen, die für Seitenblobs gelten.
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.
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 BlobSASSignatureValues 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:

  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 Cookie-Headers aus Sicherheitsgründen

  3. Entfernen von Inhaltslängenheader, um Browserwarnungen zu vermeiden
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
AccountSASPermissionsLike

Ein Typ, der wie eine Konto-SAS-Berechtigung aussieht. Wird in AccountSASPermissions verwendet, um SAS-Berechtigungen aus Rohobjekten zu analysieren.
AccountSASSignatureValues

NUR IN NODE.JS RUNTIME VERFÜGBAR.

AccountSASSignatureValues wird verwendet, um eine Shared Access Signature (SAS) für ein Azure Storage-Konto zu generieren. Nachdem alle werte hier entsprechend festgelegt wurden, rufen Sie generateAccountSASQueryParameters auf, um eine Darstellung der SAS zu erhalten, die tatsächlich auf Blob-URLs angewendet werden kann. Hinweis: Sowohl diese Klasse als auch SASQueryParameters sind vorhanden, da erstere ä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 https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas Beschreibungen der Parameter, einschließlich der erforderlichen Parameter.
AppendBlobAppendBlockFromURLOptions

Optionen zum Konfigurieren des appendBlockFromURL-Vorgangs .
AppendBlobAppendBlockFromUrlHeaders

Definiert Header für AppendBlob_appendBlockFromUrl Vorgang.
AppendBlobAppendBlockHeaders

Definiert Header für AppendBlob_appendBlock Vorgang.
AppendBlobAppendBlockOptions

Optionen zum Konfigurieren des appendBlock-Vorgangs .
AppendBlobCreateHeaders

Definiert Header für AppendBlob_create Vorgang.
AppendBlobCreateIfNotExistsOptions

Optionen zum Konfigurieren des CreateIfNotExists-Vorgangs .
AppendBlobCreateIfNotExistsResponse

Enthält Antwortdaten für den <xref:appendBlobClient.createIfNotExists> Vorgang.
AppendBlobCreateOptions

Optionen zum Konfigurieren des Erstellungsvorgangs .
AppendBlobRequestConditions

Bedingungen, die zur Erstellung dieses Anfügeblobs hinzugefügt werden sollen.
AppendBlobSealOptions

Optionen zum Konfigurieren des Versiegelungsvorgangs .
AppendPositionAccessConditions

Parametergruppe
BatchSubRequest

Eine Anforderung, die einem Batchvorgang zugeordnet ist.
BatchSubResponse

Die Antwortdaten, die einer einzelnen Anforderung innerhalb eines Batchvorgangs zugeordnet sind.
BlobAbortCopyFromURLHeaders

Definiert Header für Blob_abortCopyFromURL Vorgang.
BlobAbortCopyFromURLOptions

Optionen zum Konfigurieren des abortCopyFromURL-Vorgangs .
BlobAcquireLeaseOptions

Optionen zum Konfigurieren von Blob – Leasevorgang erwerben.
BlobBatchSubmitBatchOptionalParams

Optionen zum Konfigurieren des Diensts – Optionale Batchparameter übermitteln.
BlobBeginCopyFromURLOptions

Optionen zum Konfigurieren des beginCopyFromURL-Vorgangs .
BlobBeginCopyFromURLResponse

Enthält Antwortdaten für den beginCopyFromURL-Vorgang .
BlobBeginCopyFromUrlPollState

Der vom Poller verwendete Zustand, der von beginCopyFromURL zurückgegeben wird.

Dieser Zustand wird immer dann an den vom Benutzer angegebenen onProgress Rückruf übergeben, wenn der Kopierfortschritt erkannt wird.
BlobBreakLeaseOptions

Optionen zum Konfigurieren von Blob – Break Lease-Vorgang.
BlobChangeLeaseOptions

Optionen zum Konfigurieren von Blob – Leasevorgang ändern.
BlobCopyFromURLHeaders

Definiert Header für Blob_copyFromURL Vorgang.
BlobCreateSnapshotHeaders

Definiert Header für Blob_createSnapshot Vorgang.
BlobCreateSnapshotOptions

Optionen zum Konfigurieren des createSnapshot-Vorgangs .
BlobDeleteHeaders

Definiert Header für Blob_delete Vorgang.
BlobDeleteIfExistsResponse

Enthält Antwortdaten für den DeleteIfExists-Vorgang .
BlobDeleteImmutabilityPolicyHeaders

Definiert Header für Blob_deleteImmutabilityPolicy Vorgang.
BlobDeleteImmutabilityPolicyOptions

Optionen zum Löschen der Unveränderlichkeitsrichtlinie deleteImmutabilityPolicy-Vorgang .
BlobDeleteOptions

Optionen zum Konfigurieren des Löschvorgangs .
BlobDownloadHeaders

Definiert Header für Blob_download Vorgang.
BlobDownloadOptionalParams

Optionale Parameter.
BlobDownloadOptions

Optionen zum Konfigurieren des Downloadvorgangs .
BlobDownloadResponseParsed

Enthält Antwortdaten für den Downloadvorgang .
BlobDownloadToBufferOptions

Optionsschnittstelle für den DownloadToBuffer-Vorgang .
BlobExistsOptions

Optionen zum Konfigurieren des Exists-Vorgangs .
BlobFlatListSegment

Eine Schnittstelle, die BlobFlatListSegment darstellt.
BlobFlatListSegmentModel
BlobGenerateSasUrlOptions

Optionen zum Konfigurieren des GenerateSasUrl-Vorgangs .
BlobGetPropertiesHeaders

Definiert Header für Blob_getProperties Vorgang.
BlobGetPropertiesOptions

Optionen zum Konfigurieren des getProperties-Vorgangs .
BlobGetPropertiesResponse

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

Definiert Header für Blob_getTags Vorgang.
BlobGetTagsOptions

Optionen zum Konfigurieren des getTags-Vorgangs .
BlobHTTPHeaders

Parametergruppe
BlobHierarchyListSegment

Eine Schnittstelle, die BlobHierarchyListSegment darstellt.
BlobHierarchyListSegmentModel
BlobImmutabilityPolicy

Beschreiben der unveränderlichen Richtlinie für Blobs.
BlobItem

Ein Azure Storage-Blob
BlobItemInternal

Ein Azure Storage-Blob
BlobPrefix
BlobProperties

Eigenschaften eines Blobs
BlobQueryArrowConfiguration

Optionen zum Abfragen von Blobs im Apache Arrow-Format. Nur gültig für outputTextConfiguration.
BlobQueryArrowField

Beschreiben eines Felds in BlobQueryArrowConfiguration.
BlobQueryCsvTextConfiguration

Optionen zum Abfragen von Blobs im CSV-Format.
BlobQueryError

Fehlertyp der Blobabfrage.
BlobQueryHeaders

Definiert Header für Blob_query Vorgang.
BlobQueryJsonTextConfiguration

Optionen zum Abfragen von Blobs im JSON-Format.
BlobQueryParquetConfiguration

Optionen zum Abfragen von Blobs im Parquet-Format. Nur gültig für inputTextConfiguration.
BlobReleaseLeaseOptions

Optionen zum Konfigurieren von Blob – Release Lease-Vorgang.
BlobRenewLeaseOptions

Optionen zum Konfigurieren von Blob – Lease erneuern.
BlobRequestConditions

http-Standardheader, Tagbedingung und Leasebedingung
BlobSASPermissionsLike

Ein Typ, der wie eine Blob-SAS-Berechtigung aussieht. Wird in BlobSASPermissions verwendet, um SAS-Berechtigungen aus Rohobjekten zu analysieren.
BlobSASSignatureValues

NUR IN NODE.JS RUNTIME VERFÜGBAR.

BlobSASSignatureValues wird zum Generieren von SAS-Token des Blobdiensts für Container oder Blobs verwendet.
BlobServiceProperties

Eigenschaften des Speicherdiensts.
BlobServiceStatistics

Statistiken für den Speicherdienst.
BlobSetHTTPHeadersHeaders

Definiert Header für Blob_setHttpHeaders Vorgang.
BlobSetHTTPHeadersOptions

Optionen zum Konfigurieren des Vorgangs setHTTPHeaders .
BlobSetImmutabilityPolicyHeaders

Definiert Header für Blob_setImmutabilityPolicy Vorgang.
BlobSetImmutabilityPolicyOptions

Optionen zum Festlegen von UnveränderlichkeitsrichtliniensatzImmutabilityPolicy-Vorgang .
BlobSetLegalHoldHeaders

Definiert Header für Blob_setLegalHold Vorgang.
BlobSetLegalHoldOptions

Optionen zum Festlegen des setLegalHold-Vorgangs für die aufbewahrungsrechtliche Aufbewahrung.
BlobSetMetadataHeaders

Definiert Header für Blob_setMetadata Vorgang.
BlobSetMetadataOptions

Optionen zum Konfigurieren des vorgangs setMetadata .
BlobSetTagsHeaders

Definiert Header für Blob_setTags Vorgang.
BlobSetTagsOptions

Optionen zum Konfigurieren des setTags-Vorgangs .
BlobSetTierHeaders

Definiert Header für Blob_setTier Vorgang.
BlobSetTierOptions

Optionen zum Konfigurieren des vorgangs setAccessTier .
BlobStartCopyFromURLHeaders

Definiert Header für Blob_startCopyFromURL Vorgang.
BlobStartCopyFromURLOptions

Optionen zum Konfigurieren des beginCopyFromURL-Vorgangs .
BlobSyncCopyFromURLOptions

Optionen zum Konfigurieren des syncCopyFromURL-Vorgangs .
BlobTag
BlobTags

Blobtags
BlobUndeleteHeaders

Definiert Header für Blob_undelete Vorgang.
BlobUndeleteOptions

Optionen zum Konfigurieren des Wiederherstellenvorgangs .
Block

Stellt einen einzelnen Block in einem Blockblob dar. Es beschreibt die ID und Größe des Blocks.
BlockBlobCommitBlockListHeaders

Definiert Header für BlockBlob_commitBlockList Vorgang.
BlockBlobCommitBlockListOptions

Optionen zum Konfigurieren des commitBlockList-Vorgangs .
BlockBlobGetBlockListHeaders

Definiert Header für BlockBlob_getBlockList Vorgang.
BlockBlobGetBlockListOptions

Optionen zum Konfigurieren des getBlockList-Vorgangs .
BlockBlobParallelUploadOptions

Optionsschnittstelle für uploadFile und <xref:BlockBlobClient.uploadSeekableStream>.
BlockBlobPutBlobFromUrlHeaders

Definiert Header für BlockBlob_putBlobFromUrl Vorgang.
BlockBlobQueryOptions

Optionen zum Konfigurieren des Abfragevorgangs .
BlockBlobStageBlockFromURLHeaders

Definiert Header für BlockBlob_stageBlockFromURL Vorgang.
BlockBlobStageBlockFromURLOptions

Optionen zum Konfigurieren des stageBlockFromURL-Vorgangs .
BlockBlobStageBlockHeaders

Definiert Header für BlockBlob_stageBlock Vorgang.
BlockBlobStageBlockOptions

Optionen zum Konfigurieren des stageBlock-Vorgangs .
BlockBlobSyncUploadFromURLOptions

Optionen zum Konfigurieren des syncUploadFromURL-Vorgangs .
BlockBlobUploadHeaders

Definiert Header für BlockBlob_upload Vorgang.
BlockBlobUploadOptions

Optionen zum Konfigurieren des Uploadvorgangs .
BlockBlobUploadStreamOptions

Optionsschnittstelle für den uploadStream-Vorgang .
BlockList
CommonGenerateSasUrlOptions

Allgemeine Optionen von BlobGenerateSasUrlOptions und ContainerGenerateSasUrlOptions.
CommonOptions

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

Optionen zum Konfigurieren von Container – Leasevorgang erwerben.
ContainerBreakLeaseOptionalParams

Optionale Parameter.
ContainerBreakLeaseOptions

Optionen zum Konfigurieren von Container – Break Lease-Vorgang.
ContainerChangeLeaseOptions

Optionen zum Konfigurieren von Container – Leasevorgang ändern.
ContainerCreateHeaders

Definiert Header für Container_create Vorgang.
ContainerCreateIfNotExistsResponse

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

Optionen zum Konfigurieren des Erstellungsvorgangs .
ContainerDeleteBlobOptions

Optionen zum Konfigurieren des deleteBlob-Vorgangs .
ContainerDeleteHeaders

Definiert Header für Container_delete Vorgang.
ContainerDeleteIfExistsResponse

Enthält Antwortdaten für den DeleteIfExists-Vorgang .
ContainerDeleteMethodOptions

Optionen zum Konfigurieren des Löschvorgangs .
ContainerEncryptionScope

Parametergruppe
ContainerExistsOptions

Optionen zum Konfigurieren des Vorgangs vorhanden .
ContainerFilterBlobsHeaders

Definiert Header für Container_filterBlobs Vorgang.
ContainerFindBlobByTagsOptions

Optionen zum Konfigurieren des findBlobsByTags-Vorgangs .
ContainerGenerateSasUrlOptions

Optionen zum Konfigurieren des GenerateSasUrl-Vorgangs .
ContainerGetAccessPolicyHeaders

Definiert Header für Container_getAccessPolicy Vorgang.
ContainerGetAccessPolicyOptions

Optionen zum Konfigurieren des getAccessPolicy-Vorgangs .
ContainerGetPropertiesHeaders

Definiert Header für Container_getProperties Vorgang.
ContainerGetPropertiesOptions

Optionen zum Konfigurieren des getProperties-Vorgangs .
ContainerItem

Ein Azure Storage-Container
ContainerListBlobFlatSegmentHeaders

Definiert Header für Container_listBlobFlatSegment Vorgang.
ContainerListBlobHierarchySegmentHeaders

Definiert Header für Container_listBlobHierarchySegment Vorgang.
ContainerListBlobsOptions

Optionen zum Konfigurieren des Containers: Auflisten von Blobs-Vorgängen.

Thema
ContainerProperties

Eigenschaften eines Containers
ContainerReleaseLeaseOptions

Optionen zum Konfigurieren von Container – Release Lease-Vorgang.
ContainerRenameHeaders

Definiert Header für Container_rename Vorgang.
ContainerRenewLeaseOptions

Optionen zum Konfigurieren des Vorgangs "Container – Lease erneuern".
ContainerRequestConditions

Bedingungen, die für den Container erfüllt werden sollen.
ContainerSASPermissionsLike

Ein Typ, der wie eine Container-SAS-Berechtigung aussieht. Wird in ContainerSASPermissions verwendet, um SAS-Berechtigungen aus Rohobjekten zu analysieren.
ContainerSetAccessPolicyHeaders

Definiert Header für Container_setAccessPolicy Vorgang.
ContainerSetAccessPolicyOptions

Optionen zum Konfigurieren des vorgangs setAccessPolicy .
ContainerSetMetadataHeaders

Definiert Header für Container_setMetadata Vorgang.
ContainerSetMetadataOptions

Optionen zum Konfigurieren des vorgangs setMetadata .
ContainerUndeleteHeaders

Definiert Header für Container_restore Vorgang.
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 für denselben Ursprung bezeichnet wird und verhindert, dass eine Webseite APIs in einer anderen Domäne aufruft. CORS bietet eine sichere Möglichkeit, um einer Domäne (der Ursprungsdomäne) das Aufrufen von APIs in einer anderen Domäne zu ermöglichen.
CpkInfo

Parametergruppe
FilterBlobItem

Blobinformationen aus einem findBlobsByTags
FilterBlobItemModel

Blobinformationen aus einem Api-Api-Filteraufruf
FilterBlobSegment

Segmentantwort des findBlobsByTags-Vorgangs .
FilterBlobSegmentModel

Das Ergebnis eines Api-Aufrufs für Filterblobs
GeoReplication

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

Stellt Authentifizierungsinformationen in Authorization-, ProxyAuthorization-, WWW-Authenticate- und Proxy-Authenticate-Headerwerten dar.
HttpOperationResponse

Wrapperobjekt für HTTP-Anforderung und -Antwort. Das deserialisierte Objekt wird in der parsedBody -Eigenschaft gespeichert, wenn der Antworttext in JSON oder XML empfangen wird.
IHttpClient

Eine Schnittstelle, die HttpRequests senden und zugesagte HttpResponses empfangen kann.
Lease

Die Details für eine bestimmte Lease.
LeaseAccessConditions

Parametergruppe
LeaseOperationOptions

Konfiguriert Leasevorgänge.
ListBlobsFlatSegmentResponse

Eine Enumeration von Blobs
ListBlobsFlatSegmentResponseModel

Eine Enumeration von Blobs
ListBlobsHierarchySegmentResponse

Eine Enumeration von Blobs
ListBlobsHierarchySegmentResponseModel

Eine Enumeration von Blobs
ListContainersSegmentResponse

Eine Enumeration von Containern
Logging

Azure Analytics-Protokollierungseinstellungen.
MatchConditions

Gibt HTTP-Optionen für bedingte Anforderungen basierend auf dem ETag-Abgleich an.
Metadata

Eine Zuordnung von Name-Wert-Paaren, die der Ressource zugeordnet werden sollen.
Metrics

Eine Zusammenfassung der Anforderungsstatistiken, gruppiert nach API in Stunden- oder Minutenaggregaten für Blobs
ModificationConditions

Gibt HTTP-Optionen für bedingte Anforderungen basierend auf der Änderungszeit an.
ModifiedAccessConditions

Bedingung für bedingte HTTP-Standardheader und -Tags.
ModifiedAccessConditionsModel

Parametergruppe
ObjectReplicationPolicy

Enthält die Objektreplikationsrichtlinien-ID und die entsprechende Liste von ObjectReplicationRule. Dies wird beim Abrufen der Objektreplikationseigenschaften für das Quellblob verwendet. Die Richtlinien-ID für das Zielblob wird in ObjectReplicationDestinationPolicyId der jeweiligen Methodenantworten (z. B. festgelegt. <xref:BlobProperties.ObjectReplicationDestinationPolicyId>
ObjectReplicationRule

Enthält die Objektreplikationsregel-ID und ObjectReplicationStatus eines Blobs. Unter einer ObjectReplicationPolicy kann mehrere ObjectReplicationRule vorhanden sein.
PageBlobClearPagesHeaders

Definiert Header für PageBlob_clearPages Vorgang.
PageBlobClearPagesOptions

Optionen zum Konfigurieren des clearPages-Vorgangs .
PageBlobCopyIncrementalHeaders

Definiert Header für PageBlob_copyIncremental Vorgang.
PageBlobCreateHeaders

Definiert Header für PageBlob_create Vorgang.
PageBlobCreateIfNotExistsOptions

Optionen zum Konfigurieren des Vorgangs createIfNotExists .
PageBlobCreateIfNotExistsResponse

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

Optionen zum Konfigurieren des Erstellungsvorgangs .
PageBlobGetPageRangesDiffHeaders

Definiert Header für PageBlob_getPageRangesDiff Vorgang.
PageBlobGetPageRangesDiffOptions

Optionen zum Konfigurieren des Vorgangs <xref:PageBlobClient.getRangesDiff> .
PageBlobGetPageRangesDiffResponse

Enthält Antwortdaten für den getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions) Vorgang.
PageBlobGetPageRangesHeaders

Definiert Header für PageBlob_getPageRanges Vorgang.
PageBlobGetPageRangesOptions

Optionen zum Konfigurieren des getPageRanges-Vorgangs .
PageBlobGetPageRangesResponse

Enthält Antwortdaten für den getPageRanges(number, number, PageBlobGetPageRangesOptions) Vorgang.
PageBlobListPageRangesDiffOptions

Optionen zum Konfigurieren des listPageRangesDiff-Vorgangs .
PageBlobListPageRangesOptions

Optionen zum Konfigurieren des listPageRanges-Vorgangs .
PageBlobRequestConditions

Bedingungen, die zur Erstellung dieses Seitenblobs hinzugefügt werden sollen.
PageBlobResizeHeaders

Definiert Header für PageBlob_resize Vorgang.
PageBlobResizeOptions

Optionen zum Konfigurieren des Größenänderungsvorgangs .
PageBlobStartCopyIncrementalOptions

Optionen zum Konfigurieren des startCopyIncremental-Vorgangs .
PageBlobUpdateSequenceNumberHeaders

Definiert Header für PageBlob_updateSequenceNumber Vorgang.
PageBlobUpdateSequenceNumberOptions

Optionen zum Konfigurieren des Vorgangs updateSequenceNumber .
PageBlobUploadPagesFromURLHeaders

Definiert Header für PageBlob_uploadPagesFromURL Vorgang.
PageBlobUploadPagesFromURLOptions

Optionen zum Konfigurieren des UploadPagesFromURL-Vorgangs .
PageBlobUploadPagesHeaders

Definiert Header für PageBlob_uploadPages Vorgang.
PageBlobUploadPagesOptions

Optionen zum Konfigurieren des UploadPages-Vorgangs .
PageList

Liste der Seitenbereiche für ein Blob.
PageRangeInfo
ParsedBatchResponse

Die mehrteilige/gemischte Antwort, die die Antwort für jede Teilanforderung enthält.
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.
PollOperationState

PollOperationState enthält eine Meinungsliste mit dem kleinsten Satz von Eigenschaften, die zum Definieren eines Abfragevorgangs mit langer Ausführungszeit erforderlich sind.

Während die Poller-Klasse als lokaler Steuerungsmechanismus fungiert, um einen lang laufenden Vorgang auszulösen, zu warten und möglicherweise abzubrechen, dokumentiert PollOperationState die status des Remotevorgangs mit langer Ausführungsdauer.

Es sollte mindestens aktualisiert werden, wenn der Vorgang gestartet wird, wenn er abgeschlossen ist und wenn er abgebrochen wird. Implementierungen können jedoch eine beliebige andere Anzahl von Eigenschaften aufweisen, die aus anderen Gründen aktualisiert werden können.
PollerLike

Abstrakte Darstellung eines Pollers, der nur die minimale API verfügbar machen soll, mit der der Benutzer arbeiten muss.
PollerLikeWithCancellation

Abstrakte Darstellung eines Pollers, der nur die minimale API verfügbar machen soll, mit der der Benutzer arbeiten muss.
Range

Bereich für Blobdienstvorgänge.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations.
RequestPolicy

Die zugrunde liegende Struktur einer Anforderungsrichtlinie.
RetentionPolicy

Die Aufbewahrungsrichtlinie, die bestimmt, wie lange die zugeordneten Daten beibehalten werden sollen
SASQueryParametersOptions

Optionen zum Erstellen von SASQueryParameters.
SasIPRange

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

Parametergruppe
ServiceFilterBlobsHeaders

Definiert Header für Service_filterBlobs Vorgang.
ServiceFindBlobByTagsOptions

Optionen zum Konfigurieren des findBlobsByTags-Vorgangs .
ServiceGenerateAccountSasUrlOptions

Optionen zum Konfigurieren des GenerateAccountSasUrl-Vorgangs .
ServiceGetAccountInfoHeaders

Definiert Header für Service_getAccountInfo Vorgang.
ServiceGetAccountInfoOptions

Optionen zum Konfigurieren des getAccountInfo-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 .
ServiceGetUserDelegationKeyHeaders

Definiert Header für Service_getUserDelegationKey Vorgang.
ServiceGetUserDelegationKeyOptions

Optionen zum Konfigurieren des Diensts – Abrufen des Benutzerdelegierungsschlüssels.
ServiceListContainersOptions

Optionen zum Konfigurieren des listContainers-Vorgangs .
ServiceListContainersSegmentHeaders

Definiert Header für Service_listContainersSegment Vorgang.
ServiceRenameContainerOptions

Optionen zum Konfigurieren <xref:BlobServiceClient.renameContainer> des Vorgangs.
ServiceSetPropertiesHeaders

Definiert Header für Service_setProperties Vorgang.
ServiceSetPropertiesOptions

Optionen zum Konfigurieren des Vorgangs setProperties .
ServiceSubmitBatchHeaders

Definiert Header für Service_submitBatch Vorgang.
ServiceSubmitBatchOptionalParamsModel

Optionale Parameter.
ServiceUndeleteContainerOptions

Optionen zum Konfigurieren des UndeleteContainer-Vorgangs .
SignedIdentifier

Signierter Bezeichner.
SignedIdentifierModel

Signierter Bezeichner
StaticWebsite

Die Eigenschaften, die ein Konto zum Hosten einer statischen Website ermöglichen
StoragePipelineOptions

Optionsschnittstelle für die newPipeline-Funktion .
StorageRetryOptions

Schnittstelle für Speicherblob-Wiederholungsoptionen.
TagConditions

Gibt HTTP-Optionen für bedingte Anforderungen basierend auf Blobtags an.
UserDelegationKey

Ein Benutzerdelegierungsschlüssel.
UserDelegationKeyModel

Ein Benutzerdelegierungsschlüssel

Typaliase

AccessTier

Definiert Werte für AccessTier.
AccountKind

Definiert Werte für AccountKind.
AppendBlobAppendBlockFromUrlResponse

Enthält Antwortdaten für den appendBlockFromUrl-Vorgang.
AppendBlobAppendBlockResponse

Enthält Antwortdaten für den appendBlock-Vorgang.
AppendBlobCreateResponse

Enthält Antwortdaten für den Erstellungsvorgang.
ArchiveStatus

Definiert Werte für ArchiveStatus.
BlobAbortCopyFromURLResponse

Enthält Antwortdaten für den abortCopyFromURL-Vorgang.
BlobBatchDeleteBlobsResponse

Enthält Antwortdaten für den deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions) Vorgang.
BlobBatchSetBlobsAccessTierResponse

Enthält Antwortdaten für den setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions) Vorgang.
BlobBatchSubmitBatchResponse

Enthält Antwortdaten für Blobbatchvorgänge.
BlobCopyFromURLResponse

Enthält Antwortdaten für den CopyFromURL-Vorgang.
BlobCopySourceTags

Definiert Werte für BlobCopySourceTags.
BlobCreateSnapshotResponse

Enthält Antwortdaten für den CreateSnapshot-Vorgang.
BlobDeleteImmutabilityPolicyResponse

Enthält Antwortdaten für den DeleteImmutabilityPolicy-Vorgang.
BlobDeleteResponse

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

Enthält Antwortdaten für den Downloadvorgang.
BlobGetPropertiesResponseModel

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

Enthält Antwortdaten für den getTags-Vorgang .
BlobImmutabilityPolicyMode

Definiert Werte für BlobImmutabilityPolicyMode.
BlobQueryArrowFieldType

Der Typ eines BlobQueryArrowField.
BlobQueryResponseModel

Enthält Antwortdaten für den Abfragevorgang.
BlobSetHTTPHeadersResponse

Enthält Antwortdaten für den SetHttpHeaders-Vorgang.
BlobSetImmutabilityPolicyResponse

Enthält Antwortdaten für den SetImmutabilityPolicy-Vorgang.
BlobSetLegalHoldResponse

Enthält Antwortdaten für den SetLegalHold-Vorgang.
BlobSetMetadataResponse

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

Enthält Antwortdaten für den SetTags-Vorgang.
BlobSetTierResponse

Enthält Antwortdaten für den setTier-Vorgang.
BlobStartCopyFromURLResponse

Enthält Antwortdaten für den startCopyFromURL-Vorgang.
BlobType

Definiert Werte für BlobType.
BlobUndeleteResponse

Enthält Antwortdaten für den Wiederherstellenvorgang.
BlobUploadCommonResponse

Antworttyp für uploadFile, uploadStream und <xref:BlockBlobClient.uploadBrowserDate>.
BlockBlobCommitBlockListResponse

Enthält Antwortdaten für den CommitBlockList-Vorgang.
BlockBlobGetBlockListResponse

Enthält Antwortdaten für den getBlockList-Vorgang.
BlockBlobPutBlobFromUrlResponse

Enthält Antwortdaten für den putBlobFromUrl-Vorgang.
BlockBlobStageBlockFromURLResponse

Enthält Antwortdaten für den stageBlockFromURL-Vorgang.
BlockBlobStageBlockResponse

Enthält Antwortdaten für den stageBlock-Vorgang.
BlockBlobUploadResponse

Enthält Antwortdaten für den Uploadvorgang.
BlockListType

Definiert Werte für BlockListType.
ContainerCreateResponse

Enthält Antwortdaten für den Erstellungsvorgang.
ContainerDeleteResponse

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

Die Antwort des findBlobsByTags-Vorgangs .
ContainerGetAccessPolicyResponse

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

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

Enthält Antwortdaten für den ListBlobFlatSegment-Vorgang.
ContainerListBlobHierarchySegmentResponse

Enthält Antwortdaten für den ListBlobHierarchySegment-Vorgang.
ContainerRenameResponse

Enthält Antwortdaten für den Umbenennungsvorgang.
ContainerSetAccessPolicyResponse

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

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

Enthält Antwortdaten für den Wiederherstellungsvorgang.
CopyPollerBlobClient

Definiert die Vorgänge aus einem BlobClient , die erforderlich sind, damit der von beginCopyFromURL zurückgegebene Poller funktioniert.
CopyStatusType

Definiert Werte für CopyStatusType.
CredentialPolicyCreator

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

Definiert Werte für DeleteSnapshotsOptionType.
EncryptionAlgorithmType

Definiert Werte für EncryptionAlgorithmType.
KnownEncryptionAlgorithmType kann austauschbar mit EncryptionAlgorithmType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte Werte

AES256
GeoReplicationStatusType

Definiert Werte für GeoReplicationStatusType.
HttpRequestBody

Mögliche HTTP-Anforderungstexttypen
LeaseDurationType

Definiert Werte für LeaseDurationType.
LeaseOperationResponse

Enthält die Antwortdaten für Vorgänge, die eine Lease erstellen, ändern oder löschen.

Siehe BlobLeaseClient.
LeaseStateType

Definiert Werte für LeaseStateType.
LeaseStatusType

Definiert Werte für LeaseStatusType.
ObjectReplicationStatus

Gibt den Replikationsstatus eines Blobs an. Dies wird verwendet, wenn auf ein Speicherkonto Objektreplikationsrichtlinien angewendet wurden. Siehe ObjectReplicationPolicy und ObjectReplicationRule.
PageBlobClearPagesResponse

Enthält Antwortdaten für den clearPages-Vorgang.
PageBlobCopyIncrementalResponse

Enthält Antwortdaten für den copyIncremental-Vorgang.
PageBlobCreateResponse

Enthält Antwortdaten für den Erstellungsvorgang.
PageBlobGetPageRangesDiffResponseModel

Enthält Antwortdaten für den getPageRangesDiff-Vorgang.
PageBlobGetPageRangesResponseModel

Enthält Antwortdaten für den getPageRanges-Vorgang.
PageBlobResizeResponse

Enthält Antwortdaten für den Vorgang zum Ändern der Größe.
PageBlobUpdateSequenceNumberResponse

Enthält Antwortdaten für den Vorgang updateSequenceNumber.
PageBlobUploadPagesFromURLResponse

Enthält Antwortdaten für den UploadPagesFromURL-Vorgang.
PageBlobUploadPagesResponse

Enthält Antwortdaten für den UploadPages-Vorgang.
PublicAccessType

Definiert Werte für PublicAccessType.
RehydratePriority

Definiert Werte für RehydratePriority.
RequestPolicyFactory

Erstellt eine neue RequestPolicy pro Anforderung, die die bereitgestellte nextPolicy verwendet.
SequenceNumberActionType

Definiert Werte für SequenceNumberActionType.
ServiceFindBlobsByTagsSegmentResponse

Die Antwort des findBlobsByTags-Vorgangs .
ServiceGetAccountInfoResponse

Enthält Antwortdaten für den GetAccountInfo-Vorgang.
ServiceGetPropertiesResponse

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

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

Enthält Antwortdaten für den getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) Vorgang.
ServiceListContainersSegmentResponse

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

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

Enthält Antwortdaten für den SubmitBatch-Vorgang.
SkuName

Definiert Werte für SkuName.
SyncCopyStatusType

Definiert Werte für SyncCopyStatusType.
Tags

Blobtags.

Enumerationen

BlockBlobTier

Stellt die Zugriffsebene für ein Blob dar. Ausführliche Informationen zum Tiering auf Blockblobebene finden Sie unter Speicherebene "Heiß", "Kalt" und "Archiv".
KnownEncryptionAlgorithmType

Bekannte Werte von EncryptionAlgorithmType , die der Dienst akzeptiert.
PremiumPageBlobTier

Gibt die Seitenblobebene an, auf die das Blob festgelegt werden soll. Dies gilt nur für Seitenblobs in Storage Premium-Konten. Ausführliche Informationen zu den entsprechenden IOPS und dem Durchsatz pro PageBlobTier finden Sie hier .
SASProtocol

Protokolle für generierte SAS.
StorageBlobAudience

Definiert die bekannten Cloudgruppen für Storage.
StorageRetryPolicyType

RetryPolicy-Typen.

Functions

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Erstellen Sie eine neue Serialisierung RequestPolicyCreator, die HTTP-Anforderungstexte serialisiert, während sie die HTTP-Pipeline durchlaufen.
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.
generateBlobSASQueryParameters(BlobSASSignatureValues, 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.

Geben Sie die erforderlichen Details ein, bevor Sie die folgenden Codeausschnitte ausführen.

Beispielverwendung:

// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Beispiel für die Verwendung eines Bezeichners:

// Generate service level SAS for a container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
  {
    accessPolicy: {
      expiresOn: new Date(new Date().valueOf() + 86400), // Date type
      permissions: ContainerSASPermissions.parse("racwdl").toString(),
      startsOn: new Date() // Date type
    },
    id: identifier
  }
]);

const containerSAS = generateBlobSASQueryParameters(
  {
    containerName, // Required
    identifier // Required
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Beispiel für die Verwendung eines Blobnamens:

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Erstellt eine instance von SASQueryParameters. WARNUNG: Der Bezeichner wird beim Generieren der Sas für die Benutzerdelegierung ignoriert, Berechtigungen und Ablauf sind erforderlich.

Beispielverwendung:

// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();
getBlobServiceAccountAudience(string)
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

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

RequestPolicyFactory

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
sharedKeyCredential
StorageSharedKeyCredential

Gibt zurück

SASQueryParameters

generateBlobSASQueryParameters(BlobSASSignatureValues, 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.

Geben Sie die erforderlichen Details ein, bevor Sie die folgenden Codeausschnitte ausführen.

Beispielverwendung:

// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Beispiel für die Verwendung eines Bezeichners:

// Generate service level SAS for a container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
  {
    accessPolicy: {
      expiresOn: new Date(new Date().valueOf() + 86400), // Date type
      permissions: ContainerSASPermissions.parse("racwdl").toString(),
      startsOn: new Date() // Date type
    },
    id: identifier
  }
]);

const containerSAS = generateBlobSASQueryParameters(
  {
    containerName, // Required
    identifier // Required
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Beispiel für die Verwendung eines Blobnamens:

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parameter

blobSASSignatureValues
BlobSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Gibt zurück

SASQueryParameters

generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Erstellt eine instance von SASQueryParameters. WARNUNG: Der Bezeichner wird beim Generieren der Sas für die Benutzerdelegierung ignoriert, Berechtigungen und Ablauf sind erforderlich.

Beispielverwendung:

// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();

function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

Parameter

blobSASSignatureValues
BlobSASSignatureValues
userDelegationKey
UserDelegationKey

Rückgabewert von blobServiceClient.getUserDelegationKey()

accountName

string

Gibt zurück

SASQueryParameters

getBlobServiceAccountAudience(string) 

function getBlobServiceAccountAudience(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.