@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 <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. Sobald alle Werte festgelegt sind, 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 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 <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 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.
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.
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 oder <xref:ContainerClient> verwaltet <xref:BlobClient>.
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. Sobald alle Werte festgelegt sind, sollte dies mit toString serialisiert und als Berechtigungsfeld für ein <xref: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. Sobald alle Werte festgelegt sind, sollte dies mit toString serialisiert und als Berechtigungsfeld für ein <xref: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.
PageBlobClient

PageBlobClient definiert eine Reihe von Vorgängen, die für Seitenblobs gelten.
Pipeline

Eine Pipelineklasse, die HTTP-Anforderungsrichtlinien enthält. Sie können eine Standardpipeline erstellen, indem Sie aufrufen <xref:newPipeline>. Alternativ können Sie eine Pipeline mit Ihren eigenen Richtlinien durch den Konstruktor von Pipeline erstellen. Verweisen Sie auf <xref:newPipeline> und bereitgestellte Richtlinien, bevor Sie Ihre angepasste Pipeline implementieren.
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 <xref:AccountSASSignatureValues> Typen und <xref:BlobSASSignatureValues> generiert. Nach der Generierung kann es in eine <xref:String> 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.
StorageClient

Ein StorageClient stellt eine basierende URL-Klasse für <xref:BlobServiceClient>usw <xref:ContainerClient> . dar.
StorageClientContext
StorageRetryPolicy

Wiederholungsrichtlinie mit implementierter exponentieller Wiederholung und linearer Wiederholung.
StorageRetryPolicyFactory

StorageRetryPolicyFactory ist eine Factoryklasse, die das Generieren von <xref: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.

Schnittstellen

AccessPolicy

Eine Zugriffsrichtlinie
AccountSASPermissionsLike

Ein Typ, der wie eine Konto-SAS-Berechtigung aussieht. Wird in <xref: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 <xref:generateAccountSASQueryParameters> auf, um eine Darstellung der SAS zu erhalten, die tatsächlich auf Blob-URLs angewendet werden kann. Hinweis: Sowohl diese Klasse als auch diese Klasse <xref:SASQueryParameters> sind vorhanden, da die erstere veränderlich und eine logische Darstellung ist, während letztere unveränderlich ist und zum Generieren tatsächlicher REST-Anforderungen verwendet wird.
AppendBlobAppendBlockFromURLOptions

Optionen zum Konfigurieren des Vorgangs <xref:AppendBlobClient.appendBlockFromURL> .
AppendBlobAppendBlockFromUrlHeaders

Definiert Header für AppendBlob_appendBlockFromUrl Vorgang.
AppendBlobAppendBlockHeaders

Definiert Header für AppendBlob_appendBlock Vorgang.
AppendBlobAppendBlockOptions

Optionen zum Konfigurieren des Vorgangs <xref:AppendBlobClient.appendBlock> .
AppendBlobCreateHeaders

Definiert Header für AppendBlob_create Vorgang.
AppendBlobCreateIfNotExistsOptions

Optionen zum Konfigurieren <xref:AppendBlobClient.createIfNotExists> des Vorgangs.
AppendBlobCreateIfNotExistsResponse

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

Optionen zum Konfigurieren <xref:AppendBlobClient.create> des Vorgangs.
AppendBlobRequestConditions

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

Optionen zum Konfigurieren <xref:AppendBlobClient.seal> des Vorgangs.
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 Vorgangs <xref:BlobClient.abortCopyFromURL> .
BlobAcquireLeaseOptions

Optionen zum Konfigurieren von Blob – Leasevorgang erwerben.
BlobBatchSubmitBatchOptionalParams

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

Optionen zum Konfigurieren des Vorgangs <xref:BlobClient.beginCopyFromURL> .
BlobBeginCopyFromURLResponse

Enthält Antwortdaten für den <xref:BlobClient.beginCopyFromURL> Vorgang.
BlobBeginCopyFromUrlPollState

Der vom Poller verwendete Zustand, der von <xref:BlobClient.beginCopyFromURL>zurückgegeben wurde. 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 Vorgangs <xref:BlobClient.createSnapshot> .
BlobDeleteHeaders

Definiert Header für Blob_delete Vorgang.
BlobDeleteIfExistsResponse

Enthält Antwortdaten für den <xref:BlobClient.deleteIfExists> Vorgang.
BlobDeleteImmutabilityPolicyHeaders

Definiert Header für Blob_deleteImmutabilityPolicy Vorgang.
BlobDeleteImmutabilityPolicyOptions

Optionen zum Löschen von Unveränderlichkeitsrichtlinienvorgängen <xref:BlobClient.deleteImmutabilityPolicy> .
BlobDeleteOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobClient.delete> .
BlobDownloadHeaders

Definiert Header für Blob_download Vorgang.
BlobDownloadOptionalParams

Optionale Parameter.
BlobDownloadOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobClient.download> .
BlobDownloadResponseParsed

Enthält Antwortdaten für den <xref:BlobClient.download> Vorgang.
BlobDownloadToBufferOptions

Optionsschnittstelle für den <xref:BlobClient.downloadToBuffer> Vorgang.
BlobExistsOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobClient.exists> .
BlobFlatListSegment

Eine Schnittstelle, die BlobFlatListSegment darstellt.
BlobFlatListSegmentModel
BlobGenerateSasUrlOptions

Optionen zum Konfigurieren <xref:BlobClient.generateSasUrl> des Vorgangs.
BlobGetPropertiesHeaders

Definiert Header für Blob_getProperties Vorgang.
BlobGetPropertiesOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobClient.getProperties> .
BlobGetPropertiesResponse

Enthält Antwortdaten für den <xref:BlobClient.getProperties> Vorgang.
BlobGetTagsHeaders

Definiert Header für Blob_getTags Vorgang.
BlobGetTagsOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobClient.getTags> .
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 <xref:BlockBlobQueryOptions.outputTextConfiguration>.
BlobQueryArrowField

Beschreiben eines Felds in <xref: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 <xref:BlockBlobQueryOptions.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 <xref: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 <xref:BlobClient.setHTTPHeaders> .
BlobSetImmutabilityPolicyHeaders

Definiert Header für Blob_setImmutabilityPolicy Vorgang.
BlobSetImmutabilityPolicyOptions

Optionen zum Festlegen des Unveränderlichkeitsrichtlinienvorgangs <xref:BlobClient.setImmutabilityPolicy> .
BlobSetLegalHoldHeaders

Definiert Header für Blob_setLegalHold Vorgang.
BlobSetLegalHoldOptions

Optionen zum Festlegen des Legal Hold-Vorgangs <xref:BlobClient.setLegalHold> .
BlobSetMetadataHeaders

Definiert Header für Blob_setMetadata Vorgang.
BlobSetMetadataOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobClient.setMetadata> .
BlobSetTagsHeaders

Definiert Header für Blob_setTags Vorgang.
BlobSetTagsOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobClient.setTags> .
BlobSetTierHeaders

Definiert Header für Blob_setTier Vorgang.
BlobSetTierOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobClient.setAccessTier> .
BlobStartCopyFromURLHeaders

Definiert Header für Blob_startCopyFromURL Vorgang.
BlobStartCopyFromURLOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobClient.beginCopyFromURL> .
BlobSyncCopyFromURLOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobClient.syncCopyFromURL> .
BlobTag
BlobTags

Blobtags
BlobUndeleteHeaders

Definiert Header für Blob_undelete Vorgang.
BlobUndeleteOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobClient.undelete> .
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 <xref:BlockBlobClient.commitBlockList> des Vorgangs.
BlockBlobGetBlockListHeaders

Definiert Header für BlockBlob_getBlockList Vorgang.
BlockBlobGetBlockListOptions

Optionen zum Konfigurieren <xref:BlockBlobClient.getBlockList> des Vorgangs.
BlockBlobParallelUploadOptions

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

Definiert Header für BlockBlob_putBlobFromUrl Vorgang.
BlockBlobQueryOptions

Optionen zum Konfigurieren <xref:BlockBlobClient.query> des Vorgangs.
BlockBlobStageBlockFromURLHeaders

Definiert Header für BlockBlob_stageBlockFromURL Vorgang.
BlockBlobStageBlockFromURLOptions

Optionen zum Konfigurieren <xref:BlockBlobClient.stageBlockFromURL> des Vorgangs.
BlockBlobStageBlockHeaders

Definiert Header für BlockBlob_stageBlock Vorgang.
BlockBlobStageBlockOptions

Optionen zum Konfigurieren <xref:BlockBlobClient.stageBlock> des Vorgangs.
BlockBlobSyncUploadFromURLOptions

Optionen zum Konfigurieren <xref:BlockBlobClient.syncUploadFromURL> des Vorgangs.
BlockBlobUploadHeaders

Definiert Header für BlockBlob_upload Vorgang.
BlockBlobUploadOptions

Optionen zum Konfigurieren <xref:BlockBlobClient.upload> des Vorgangs.
BlockBlobUploadStreamOptions

Optionsschnittstelle für den <xref:BlockBlobClient.uploadStream> Vorgang.
BlockList
CommonGenerateSasUrlOptions

Allgemeine Optionen von <xref:BlobGenerateSasUrlOptions> und <xref: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 <xref:ContainerClient.createIfNotExists> Vorgang.
ContainerCreateOptions

Optionen zum Konfigurieren <xref:ContainerClient.create> des Vorgangs.
ContainerDeleteBlobOptions

Optionen zum Konfigurieren des Vorgangs <xref:ContainerClient.deleteBlob> .
ContainerDeleteHeaders

Definiert Header für Container_delete Vorgang.
ContainerDeleteIfExistsResponse

Enthält Antwortdaten für den <xref:ContainerClient.deleteIfExists> Vorgang.
ContainerDeleteMethodOptions

Optionen zum Konfigurieren <xref:ContainerClient.delete> des Vorgangs.
ContainerEncryptionScope

Parametergruppe
ContainerExistsOptions

Optionen zum Konfigurieren <xref:ContainerClient.exists> des Vorgangs.
ContainerGenerateSasUrlOptions

Optionen zum Konfigurieren <xref:ContainerClient.generateSasUrl> des Vorgangs.
ContainerGetAccessPolicyHeaders

Definiert Header für Container_getAccessPolicy Vorgang.
ContainerGetAccessPolicyOptions

Optionen zum Konfigurieren <xref:ContainerClient.getAccessPolicy> des Vorgangs.
ContainerGetPropertiesHeaders

Definiert Header für Container_getProperties Vorgang.
ContainerGetPropertiesOptions

Optionen zum Konfigurieren <xref:ContainerClient.getProperties> des 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

  • <xref:ContainerClient.listBlobsFlat>
  • <xref:ContainerClient.listBlobsByHierarchy>
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 <xref:ContainerSASPermissions> verwendet, um SAS-Berechtigungen aus Rohobjekten zu analysieren.
ContainerSetAccessPolicyHeaders

Definiert Header für Container_setAccessPolicy Vorgang.
ContainerSetAccessPolicyOptions

Optionen zum Konfigurieren <xref:ContainerClient.setAccessPolicy> des Vorgangs.
ContainerSetMetadataHeaders

Definiert Header für Container_setMetadata Vorgang.
ContainerSetMetadataOptions

Optionen zum Konfigurieren <xref:ContainerClient.setMetadata> des Vorgangs.
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 <xref:BlobServiceClient.findBlobsByTags>
FilterBlobItemModel

Blobinformationen aus einem Api-Api-Filteraufruf
FilterBlobSegment

Segmentantwort des Vorgangs <xref:BlobServiceClient.findBlobsByTags> .
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.
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 ETag-Abgleich an.
Metadata

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

Eine Zusammenfassung der Nach API gruppierten Anforderungsstatistiken 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 Id der Objektreplikationsrichtlinie und die entsprechende Liste von <xref:ObjectReplicationRule>. Dies wird beim Abrufen der Objektreplikationseigenschaften im Quellblob verwendet. Die Richtlinien-ID für das Zielblob wird in ObjectReplicationDestinationPolicyId der entsprechenden Methodenantworten festgelegt (z. B. <xref:BlobProperties.ObjectReplicationDestinationPolicyId>.
ObjectReplicationRule

Enthält die Objektreplikationsregel-ID und <xref:ObjectReplicationStatus> ein Blob. Es kann mehrere unter einem <xref:ObjectReplicationRule><xref:ObjectReplicationPolicy>sein.
PageBlobClearPagesHeaders

Definiert Header für PageBlob_clearPages Vorgang.
PageBlobClearPagesOptions

Optionen zum Konfigurieren des Vorgangs <xref:PageBlobClient.clearPages> .
PageBlobCopyIncrementalHeaders

Definiert Header für PageBlob_copyIncremental Vorgang.
PageBlobCreateHeaders

Definiert Header für PageBlob_create Vorgang.
PageBlobCreateIfNotExistsOptions

Optionen zum Konfigurieren des Vorgangs <xref:PageBlobClient.createIfNotExists> .
PageBlobCreateIfNotExistsResponse

Enthält Antwortdaten für den <xref:PageBlobClient.createIfNotExists> Vorgang.
PageBlobCreateOptions

Optionen zum Konfigurieren des Vorgangs <xref:PageBlobClient.create> .
PageBlobGetPageRangesDiffHeaders

Definiert Header für PageBlob_getPageRangesDiff Vorgang.
PageBlobGetPageRangesDiffOptions

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

Enthält Antwortdaten für den <xref:BlobClient.getPageRangesDiff> Vorgang.
PageBlobGetPageRangesHeaders

Definiert Header für PageBlob_getPageRanges Vorgang.
PageBlobGetPageRangesOptions

Optionen zum Konfigurieren des Vorgangs <xref:PageBlobClient.getPageRanges> .
PageBlobGetPageRangesResponse

Enthält Antwortdaten für den <xref:BlobClient.getPageRanges> Vorgang.
PageBlobRequestConditions

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

Definiert Header für PageBlob_resize Vorgang.
PageBlobResizeOptions

Optionen zum Konfigurieren <xref:PageBlobClient.resize> des Vorgangs.
PageBlobStartCopyIncrementalOptions

Optionen zum Konfigurieren <xref:PageBlobClient.startCopyIncremental> des Vorgangs.
PageBlobUpdateSequenceNumberHeaders

Definiert Header für PageBlob_updateSequenceNumber Vorgang.
PageBlobUpdateSequenceNumberOptions

Optionen zum Konfigurieren <xref:PageBlobClient.updateSequenceNumber> des Vorgangs.
PageBlobUploadPagesFromURLHeaders

Definiert Header für PageBlob_uploadPagesFromURL Vorgang.
PageBlobUploadPagesFromURLOptions

Optionen zum Konfigurieren <xref:PageBlobClient.uploadPagesFromURL> des Vorgangs.
PageBlobUploadPagesHeaders

Definiert Header für PageBlob_uploadPages Vorgang.
PageBlobUploadPagesOptions

Optionen zum Konfigurieren des Vorgangs <xref:PageBlobClient.uploadPages> .
PageList

Liste der Seitenbereiche für ein Blob.
ParsedBatchResponse

Die mehrteilige/gemischte Antwort, die die Antwort für jede Unteranforderung enthält.
PipelineLike

Eine Schnittstelle für die -Klasse, die <xref:Pipeline> HTTP-Anforderungsrichtlinien enthält. Sie können eine Standardpipeline erstellen, indem Sie aufrufen <xref:newPipeline>. Alternativ können Sie eine Pipeline mit Ihren eigenen Richtlinien durch den Konstruktor von Pipeline erstellen. Verweisen Sie auf <xref:newPipeline> und bereitgestellte Richtlinien, bevor Sie Ihre angepasste Pipeline implementieren.
PipelineOptions

Optionsschnittstelle für pipeline-Konstruktor.
Range

Bereich für Blobdienstvorgänge.
RetentionPolicy

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

Optionen zum Erstellen <xref:SASQueryParameters>von .
SasIPRange

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

Parametergruppe
ServiceFilterBlobsHeaders

Definiert Header für Service_filterBlobs Vorgang.
ServiceFindBlobByTagsOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobServiceClient.findBlobsByTags> .
ServiceGenerateAccountSasUrlOptions

Optionen zum Konfigurieren <xref:BlobServiceClient.generateAccountSasUrl> des Vorgangs.
ServiceGetAccountInfoHeaders

Definiert Header für Service_getAccountInfo Vorgang.
ServiceGetAccountInfoOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobServiceClient.getAccountInfo> .
ServiceGetPropertiesHeaders

Definiert Header für Service_getProperties Vorgang.
ServiceGetPropertiesOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobServiceClient.getProperties> .
ServiceGetStatisticsHeaders

Definiert Header für Service_getStatistics Vorgang.
ServiceGetStatisticsOptions

Optionen zum Konfigurieren des Vorgangs <xref:BlobServiceClient.getStatistics> .
ServiceGetUserDelegationKeyHeaders

Definiert Header für Service_getUserDelegationKey Vorgang.
ServiceGetUserDelegationKeyOptions

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

Optionen zum Konfigurieren des Vorgangs <xref:BlobServiceClient.listContainers> .
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 <xref:BlobServiceClient.setProperties> .
ServiceSubmitBatchHeaders

Definiert Header für Service_submitBatch Vorgang.
ServiceSubmitBatchOptionalParamsModel

Optionale Parameter.
ServiceUndeleteContainerOptions

Optionen zum Konfigurieren <xref:BlobServiceClient.undeleteContainer> des Vorgangs.
SignedIdentifier

Signierter Bezeichner.
SignedIdentifierModel

Signierter Bezeichner
StaticWebsite

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

Optionale Parameter.
StoragePipelineOptions

Optionsschnittstelle für die <xref: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 <xref:deleteBlobs> Vorgang.
BlobBatchSetBlobsAccessTierResponse

Enthält Antwortdaten für den <xref:setBlobsAccessTier> Vorgang.
BlobBatchSubmitBatchResponse

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

Enthält Antwortdaten für den CopyFromURL-Vorgang.
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 <xref:BlobClient.getTags> Vorgang.
BlobImmutabilityPolicyMode

Definiert Werte für BlobImmutabilityPolicyMode.
BlobQueryArrowFieldType

Der Typ eines <xref: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 <xref:BlockBlobClient.uploadFile>, <xref:BlockBlobClient.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.
ContainerGetAccessPolicyResponse

Enthält Antwortdaten für den <xref:ContainerClient.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 <xref:BlobClient> , die erforderlich sind, damit der von <xref:BlobClient.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.
GeoReplicationStatusType

Definiert Werte für GeoReplicationStatusType.
LeaseDurationType

Definiert Werte für LeaseDurationType.
LeaseOperationResponse

Enthält die Antwortdaten für Vorgänge, die eine Lease erstellen, ändern oder löschen. Siehe <xref:BlobLeaseClient>.
LeaseStateType

Definiert Werte für LeaseStateType.
LeaseStatusType

Definiert Werte für LeaseStatusType.
ListBlobsIncludeItem

Definiert Werte für ListBlobsIncludeItem.
ListContainersIncludeType

Definiert Werte für ListContainersIncludeType.
ObjectReplicationStatus

Gibt den Replikationsstatus eines Blobs an. Dies wird verwendet, wenn auf ein Speicherkonto Objektreplikationsrichtlinien angewendet wurden. Prüfen Sie <xref:ObjectReplicationPolicy> und <xref: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.
PageBlobResizeResponse

Enthält Antwortdaten für den Größenänderungsvorgang.
PageBlobUpdateSequenceNumberResponse

Enthält Antwortdaten für den UpdateSequenceNumber-Vorgang.
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.
SequenceNumberActionType

Definiert Werte für SequenceNumberActionType.
ServiceFindBlobsByTagsSegmentResponse

Die Antwort des Vorgangs <xref:BlobServiceClient.findBlobsByTags> .
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 <xref:getUserDelegationKey> 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".
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.
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 Ausführen einer tatsächlichen REST-Anforderung erforderlich sind.
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();
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 <xref:SASQueryParameters> -Objekt, das alle SAS-Abfrageparameter enthält, die zum Ausführen einer tatsächlichen REST-Anforderung erforderlich sind.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

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)

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)

Parameter

blobSASSignatureValues
BlobSASSignatureValues
userDelegationKey
UserDelegationKey

Rückgabewert von blobServiceClient.getUserDelegationKey()

accountName

string

Gibt zurück

SASQueryParameters

isPipelineLike(unknown)

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

function isPipelineLike(pipeline: unknown)

Parameter

pipeline

unknown

Ein Argument, das eine Pipeline sein kann

Gibt zurück

boolean

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)

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.