AppendBlobClient class
AppendBlobClient definiert eine Reihe von Vorgängen, die für das Anfügen von Blobs gelten.
- Extends
Konstruktoren
Append |
Erstellt eine Instanz von AppendBlobClient. Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Anfüge-Blob zeigt. Codierte URL-Zeichenfolge wird nicht zweimal escapet, es werden nur Sonderzeichen im URL-Pfad escaped. Wenn ein BLOB-Name enthält? oder %muss der BLOB-Name in der URL codiert werden. |
Append |
Erstellt eine Instanz von AppendBlobClient. Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Anfüge-Blob zeigt. Codierte URL-Zeichenfolge wird nicht zweimal escapet, es werden nur Sonderzeichen im URL-Pfad escaped. Wenn ein BLOB-Name enthält? oder %muss der BLOB-Name in der URL codiert werden. |
Append |
Erstellt eine Instanz von AppendBlobClient. |
Eigenschaften
container |
Der Name des Speichercontainers, dem das Blob zugeordnet ist. |
name | Der Name des Blobs. |
Geerbte Eigenschaften
account |
|
credential | Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem |
url | Codierter URL-Zeichenfolgenwert. |
Methoden
append |
Commits a new block of data to the end of the existing append blob. Siehe https://docs.microsoft.com/rest/api/storageservices/append-block |
append |
Mit dem Append Block-Vorgang wird ein neuer Datenblock am Ende eines vorhandenen Anfüge-Blobs ausgeführt, in dem der Inhalt aus einer Quell-URL gelesen wird. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url |
create(Append |
Erstellt einen 0-längen Anfüge-BLOB. Aufrufen von AppendBlock zum Anfügen von Daten an ein Anfügebb. Siehe https://docs.microsoft.com/rest/api/storageservices/put-blob |
create |
Erstellt einen 0-längen Anfüge-BLOB. Aufrufen von AppendBlock zum Anfügen von Daten an ein Anfügebb. Wenn das Blob mit demselben Namen bereits vorhanden ist, bleibt der Inhalt des vorhandenen Blobs unverändert. Siehe https://docs.microsoft.com/rest/api/storageservices/put-blob |
seal(Append |
Versiegelt den Anfügebb, sodass er schreibgeschützt ist. |
with |
Erstellt ein neues AppendBlobClient -Objekt identisch mit der Quelle, aber mit dem angegebenen Momentaufnahmezeitstempel. Geben Sie "" entfernt die Momentaufnahme und gibt einen Client an das Basis-Blob zurück. |
Geerbte Methoden
abort |
Bricht einen ausstehenden asynchronen Kopier-Blob-Vorgang ab und belässt ein Ziel-Blob mit null Länge und vollständigen Metadaten. Version 2012-02-12 und höher. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob |
begin |
Kopiert asynchron ein BLOB in ein Ziel innerhalb des Speicherkontos.
Diese Methode gibt einen Abfragevorgang mit langer Ausführung zurück, mit dem Sie auf unbestimmte Zeit warten können, bis die Kopie abgeschlossen ist.
Sie können eine Kopie auch abbrechen, bevor sie abgeschlossen wird, indem Sie In Version 2012-02-12 und höher kann die Quelle für einen Kopier-Blob-Vorgang ein zugesichertes Blob in einem beliebigen Azure-Speicherkonto sein. Ab Version 2015-02-21 kann es sich bei der Quelle für einen Kopier-BLOB-Vorgang um eine Azure-Datei in einem beliebigen Azure-Speicherkonto handeln. Nur Speicherkonten, die am oder nach dem 7. Juni 2012 erstellt wurden, ermöglichen es dem Kopier-BLOB-Vorgang, aus einem anderen Speicherkonto zu kopieren. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Beispiel für die automatische Abfrage:
Beispiel für die manuelle Abfrage:
Beispiel für die Verwendung von Statusaktualisierungen:
Beispiel für die Verwendung eines sich ändernden Abrufintervalls (Standard 15 Sekunden):
Beispiel für die Verwendung des Kopierabbruchs:
|
create |
Erstellt eine schreibgeschützte Momentaufnahme eines Blobs. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob |
delete(Blob |
Markiert das angegebene Blob oder die angegebene Momentaufnahme für das Löschen. Das Blob wird später während der Garbage Collection gelöscht. Beachten Sie, dass Sie zum Löschen eines Blobs alle Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang "Blob löschen" löschen. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
delete |
Markiert den angegebenen Blob oder die angegebene Momentaufnahme für den Löschvorgang, falls vorhanden. Das Blob wird später während der Garbage Collection gelöscht. Beachten Sie, dass Sie zum Löschen eines Blobs alle Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang "Blob löschen" löschen. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
delete |
Löschen Sie die Immutablilitätsrichtlinie für das Blob. |
download(number, number, Blob |
Liest oder lädt ein Blob aus dem System herunter, einschließlich seiner Metadaten und Eigenschaften. Sie können get Blob auch aufrufen, um eine Momentaufnahme zu lesen.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob |
download |
NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure Blob parallel zu einem Puffer herunter. Offset und Anzahl sind optional, lädt das gesamte BLOB herunter, wenn sie nicht bereitgestellt werden. Warnung: Puffer können Dateien nur bis zu einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen, da einschränkungen von Node.js/V8. Berücksichtigen Sie für Blobs, die größer als diese Größe sind, downloadToFile-. |
download |
NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure Blob parallel zu einem Puffer herunter. Offset und Anzahl sind optional, lädt das gesamte BLOB herunter, wenn sie nicht bereitgestellt werden. Warnung: Puffer können Dateien nur bis zu einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen, da einschränkungen von Node.js/V8. Berücksichtigen Sie für Blobs, die größer als diese Größe sind, downloadToFile-. |
download |
NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure Blob in eine lokale Datei herunter. Schlägt fehl, wenn der angegebene Dateipfad bereits beendet wird. Offset und Anzahl sind optional, übergeben 0 und nicht definiert, um das gesamte Blob herunterzuladen. |
exists(Blob |
Gibt "true" zurück, wenn die von diesem Client dargestellte Azure-Blobressource vorhanden ist. andernfalls "false". HINWEIS: Verwenden Sie diese Funktion mit Bedacht, da ein vorhandenes BLOB möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Blobs von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen wurde. |
generate |
Nur für BlobClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde. Generiert einen SAS-URI (Blob Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
get |
Der Vorgang "Kontoinformationen abrufen" gibt den SKU-Namen und die Kontoart für das angegebene Konto zurück. Der Vorgang "Kontoinformationen abrufen" ist in Dienstversionen ab Version 2018-03-28 verfügbar. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information |
get |
Erstellt ein AppendBlobClient -Objekt. |
get |
Rufen Sie eine BlobLeaseClient- ab, die Leases für das Blob verwaltet. |
get |
Erstellt ein BlockBlobClient -Objekt. |
get |
Erstellt ein PageBlobClient -Objekt. |
get |
Gibt alle benutzerdefinierten Metadaten, Standard-HTTP-Eigenschaften und Systemeigenschaften für das Blob zurück. Der Inhalt des BLOB wird nicht zurückgegeben. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties WARNUNG: Das in der Antwort zurückgegebene |
get |
Ruft die Tags ab, die dem zugrunde liegenden Blob zugeordnet sind. |
set |
Legt die Ebene für ein Blob fest. Der Vorgang ist in einem Seiten-BLOB in einem Premium-Speicherkonto und in einem Block-Blob in einem Blob-Speicherkonto zulässig (nur lokal redundanter Speicher). Die Ebene eines Premiumseiten-Blobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Block-BLOB bestimmt den Speichertyp "Hot/Cool/Archive". Dieser Vorgang aktualisiert das ETag des BLOB nicht. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier |
set |
Legt Systemeigenschaften für das Blob fest. Wenn kein Wert angegeben oder kein Wert für die angegebenen BLOB-HTTP-Header bereitgestellt wird, werden diese BLOB-HTTP-Header ohne einen Wert gelöscht. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
set |
Legen Sie die Unveränderlichkeitsrichtlinie für das Blob fest. |
set |
Legen Sie den gesetzlichen Halteraum für das Blob fest. |
set |
Legt benutzerdefinierte Metadaten für das angegebene Blob als ein oder mehrere Name-Wert-Paare fest. Wenn im Parameter keine Option angegeben oder keine Metadaten definiert sind, werden die BLOB-Metadaten entfernt. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata |
set |
Legt Tags für das zugrunde liegende Blob fest. Ein Blob kann bis zu 10 Tags aufweisen. Tagtasten müssen zwischen 1 und 128 Zeichen bestehen. Tagwerte müssen zwischen 0 und 256 Zeichen bestehen. Gültige Tagschlüssel- und Wertzeichen umfassen Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen (' '), Pluszeichen ('+'), Minuszeichen ('-'), Punkt ('.'), Schrägstrich ('/'), Doppelpunkt (':'), gleich ('=') und Unterstrich ('_'). |
sync |
Der synchrone Kopiervorgang von URL kopiert ein BLOB oder eine Internetressource in ein neues Blob. Sie gibt erst dann eine Antwort zurück, wenn die Kopie abgeschlossen ist. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url |
undelete(Blob |
Stellt den Inhalt und die Metadaten eines vorläufig gelöschten Blobs und alle zugeordneten vorläufig gelöschten Momentaufnahmen wieder her. Undelete Blob wird nur unter Version 2017-07-29 oder höher unterstützt. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob |
with |
Erstellt ein neues BlobClient -Objekt, das auf eine Version dieses Blob zeigt. Geben Sie "" entfernt die versionId und gibt einen Client an das Basis-Blob zurück. |
Details zum Konstruktor
AppendBlobClient(string, PipelineLike)
Erstellt eine Instanz von AppendBlobClient. Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Anfüge-Blob zeigt. Codierte URL-Zeichenfolge wird nicht zweimal escapet, es werden nur Sonderzeichen im URL-Pfad escaped. Wenn ein BLOB-Name enthält? oder %muss der BLOB-Name in der URL codiert werden.
new AppendBlobClient(url: string, pipeline: PipelineLike)
Parameter
- url
-
string
Eine URL-Zeichenfolge, die auf das Anfüge-BLOB von Azure Storage verweist, z. B. "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Sie können eine SAS anfügen, wenn Anonyme Anmeldeinformationen verwendet werden, z. B. "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Blob verweist. Codierte URL-Zeichenfolge wird nicht zweimal escapet, es werden nur Sonderzeichen im URL-Pfad escaped. Wenn ein BLOB-Name jedoch enthält? oder %muss der BLOB-Name in der URL codiert werden. Wie z. B. ein Blob mit dem Namen "my?blob%", sollte die URL "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"" sein.
- pipeline
- PipelineLike
Rufen Sie newPipeline() auf, um eine Standardpipeline zu erstellen oder eine angepasste Pipeline bereitzustellen.
AppendBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Erstellt eine Instanz von AppendBlobClient. Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Anfüge-Blob zeigt. Codierte URL-Zeichenfolge wird nicht zweimal escapet, es werden nur Sonderzeichen im URL-Pfad escaped. Wenn ein BLOB-Name enthält? oder %muss der BLOB-Name in der URL codiert werden.
new AppendBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parameter
- url
-
string
Eine URL-Zeichenfolge, die auf das Anfüge-BLOB von Azure Storage verweist, z. B. "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Sie können eine SAS anfügen, wenn Anonyme Anmeldeinformationen verwendet werden, z. B. "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Blob verweist. Codierte URL-Zeichenfolge wird nicht zweimal escapet, es werden nur Sonderzeichen im URL-Pfad escaped. Wenn ein BLOB-Name jedoch enthält? oder %muss der BLOB-Name in der URL codiert werden. Wie z. B. ein Blob mit dem Namen "my?blob%", sollte die URL "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"" sein.
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity
-Paket zum Authentifizieren von Anforderungen an den Dienst. Sie können auch ein Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.
- options
- StoragePipelineOptions
Wahlfrei. Optionen zum Konfigurieren der HTTP-Pipeline.
AppendBlobClient(string, string, string, StoragePipelineOptions)
Erstellt eine Instanz von AppendBlobClient.
new AppendBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
Parameter
- connectionString
-
string
Kontoverbindungszeichenfolge oder SAS-Verbindungszeichenfolge eines Azure-Speicherkontos.
[ Hinweis : Kontoverbindungszeichenfolge kann nur in NODE.JS Laufzeit verwendet werden. ] Beispiel für kontoverbindungszeichenfolge - beispiel für DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
SAS-Verbindungszeichenfolge - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
- containerName
-
string
Containername.
- blobName
-
string
Blobname.
- options
- StoragePipelineOptions
Wahlfrei. Optionen zum Konfigurieren der HTTP-Pipeline.
Details zur Eigenschaft
containerName
Der Name des Speichercontainers, dem das Blob zugeordnet ist.
string containerName
Eigenschaftswert
string
name
Der Name des Blobs.
string name
Eigenschaftswert
string
Geerbte Eigenschaftsdetails
accountName
credential
Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity
-Paket zum Authentifizieren von Anforderungen an den Dienst. Sie können auch ein Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Eigenschaftswert
url
Details zur Methode
appendBlock(RequestBodyType, number, AppendBlobAppendBlockOptions)
Commits a new block of data to the end of the existing append blob.
Siehe https://docs.microsoft.com/rest/api/storageservices/append-block
function appendBlock(body: RequestBodyType, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>
Parameter
- body
- HttpRequestBody
Daten, die angefügt werden sollen.
- contentLength
-
number
Länge des Textkörpers in Byte.
- options
- AppendBlobAppendBlockOptions
Optionen für den Anfügeblock-Vorgang.
Beispielverwendung:
const content = "Hello World!";
// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);
// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);
Gibt zurück
Promise<AppendBlobAppendBlockResponse>
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)
Mit dem Append Block-Vorgang wird ein neuer Datenblock am Ende eines vorhandenen Anfüge-Blobs ausgeführt, in dem der Inhalt aus einer Quell-URL gelesen wird.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url
function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>
Parameter
- sourceURL
-
string
Die URL zum Blob, die die Quelle der Kopie ist. Ein Quell-BLOB im selben Speicherkonto kann über freigegebenen Schlüssel authentifiziert werden. Wenn die Quelle jedoch ein Blob in einem anderen Konto ist, muss das Quell-BLOB entweder öffentlich sein oder über eine freigegebene Zugriffssignatur authentifiziert werden. Wenn das Quell-BLOB öffentlich ist, ist keine Authentifizierung erforderlich, um den Vorgang auszuführen.
- sourceOffset
-
number
Offset in der Quelle, die angefügt werden soll
- count
-
number
Anzahl der Bytes, die als Block angefügt werden sollen
Gibt zurück
Promise<AppendBlobAppendBlockFromUrlResponse>
create(AppendBlobCreateOptions)
Erstellt einen 0-längen Anfüge-BLOB. Aufrufen von AppendBlock zum Anfügen von Daten an ein Anfügebb.
Siehe https://docs.microsoft.com/rest/api/storageservices/put-blob
function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>
Parameter
- options
- AppendBlobCreateOptions
Optionen für den Vorgang zum Anfügen von Blockerstellung.
Beispielverwendung:
const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();
Gibt zurück
Promise<AppendBlobCreateResponse>
createIfNotExists(AppendBlobCreateIfNotExistsOptions)
Erstellt einen 0-längen Anfüge-BLOB. Aufrufen von AppendBlock zum Anfügen von Daten an ein Anfügebb. Wenn das Blob mit demselben Namen bereits vorhanden ist, bleibt der Inhalt des vorhandenen Blobs unverändert.
Siehe https://docs.microsoft.com/rest/api/storageservices/put-blob
function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>
Parameter
Gibt zurück
Promise<AppendBlobCreateIfNotExistsResponse>
seal(AppendBlobSealOptions)
Versiegelt den Anfügebb, sodass er schreibgeschützt ist.
function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>
Parameter
- options
- AppendBlobSealOptions
Gibt zurück
Promise<AppendBlobAppendBlockResponse>
withSnapshot(string)
Erstellt ein neues AppendBlobClient -Objekt identisch mit der Quelle, aber mit dem angegebenen Momentaufnahmezeitstempel. Geben Sie "" entfernt die Momentaufnahme und gibt einen Client an das Basis-Blob zurück.
function withSnapshot(snapshot: string): AppendBlobClient
Parameter
- snapshot
-
string
Der Momentaufnahmezeitstempel.
Gibt zurück
Ein neues AppendBlobClient -Objekt identisch mit der Quelle, aber mit dem angegebenen Momentaufnahmezeitstempel.
Details zur geerbten Methode
abortCopyFromURL(string, BlobAbortCopyFromURLOptions)
Bricht einen ausstehenden asynchronen Kopier-Blob-Vorgang ab und belässt ein Ziel-Blob mit null Länge und vollständigen Metadaten. Version 2012-02-12 und höher.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>
Parameter
- copyId
-
string
ID des Vorgangs "Von URL kopieren".
- options
- BlobAbortCopyFromURLOptions
Optionale Optionen für den Vorgang "BlobAbort Copy From URL".
Gibt zurück
Promise<BlobAbortCopyFromURLResponse>
geerbt vonBlobClient.abortCopyFromURL-
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)
Kopiert asynchron ein BLOB in ein Ziel innerhalb des Speicherkontos.
Diese Methode gibt einen Abfragevorgang mit langer Ausführung zurück, mit dem Sie auf unbestimmte Zeit warten können, bis die Kopie abgeschlossen ist.
Sie können eine Kopie auch abbrechen, bevor sie abgeschlossen wird, indem Sie cancelOperation
für den Abrufer aufrufen.
Beachten Sie, dass der onProgress-Rückruf nicht aufgerufen wird, wenn der Vorgang in der ersten Anforderung abgeschlossen ist, und der Versuch, eine abgeschlossene Kopie abzubrechen, führt zu einem Fehler, der ausgelöst wird.
In Version 2012-02-12 und höher kann die Quelle für einen Kopier-Blob-Vorgang ein zugesichertes Blob in einem beliebigen Azure-Speicherkonto sein. Ab Version 2015-02-21 kann es sich bei der Quelle für einen Kopier-BLOB-Vorgang um eine Azure-Datei in einem beliebigen Azure-Speicherkonto handeln. Nur Speicherkonten, die am oder nach dem 7. Juni 2012 erstellt wurden, ermöglichen es dem Kopier-BLOB-Vorgang, aus einem anderen Speicherkonto zu kopieren.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob
Beispiel für die automatische Abfrage:
const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();
Beispiel für die manuelle Abfrage:
const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
await poller.poll();
}
const result = copyPoller.getResult();
Beispiel für die Verwendung von Statusaktualisierungen:
const copyPoller = await blobClient.beginCopyFromURL('url', {
onProgress(state) {
console.log(`Progress: ${state.copyProgress}`);
}
});
const result = await copyPoller.pollUntilDone();
Beispiel für die Verwendung eines sich ändernden Abrufintervalls (Standard 15 Sekunden):
const copyPoller = await blobClient.beginCopyFromURL('url', {
intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();
Beispiel für die Verwendung des Kopierabbruchs:
const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
await copyPoller.cancelOperation();
// calls to get the result now throw PollerCancelledError
await copyPoller.getResult();
} catch (err) {
if (err.name === 'PollerCancelledError') {
console.log('The copy was cancelled.');
}
}
function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
Parameter
- copySource
-
string
url to the source Azure Blob/File.
- options
- BlobBeginCopyFromURLOptions
Optionale Optionen für den Blob Start Copy From URL-Vorgang.
Gibt zurück
Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
geerbt vonBlobClient.beginCopyFromURL-
createSnapshot(BlobCreateSnapshotOptions)
Erstellt eine schreibgeschützte Momentaufnahme eines Blobs.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>
Parameter
- options
- BlobCreateSnapshotOptions
Optionale Optionen für den Blob Create Snapshot-Vorgang.
Gibt zurück
Promise<BlobCreateSnapshotResponse>
geerbt vonBlobClient.createSnapshot-
delete(BlobDeleteOptions)
Markiert das angegebene Blob oder die angegebene Momentaufnahme für das Löschen. Das Blob wird später während der Garbage Collection gelöscht. Beachten Sie, dass Sie zum Löschen eines Blobs alle Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang "Blob löschen" löschen.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>
Parameter
- options
- BlobDeleteOptions
Optionale Optionen für blob Delete-Vorgang.
Gibt zurück
Promise<BlobDeleteResponse>
deleteIfExists(BlobDeleteOptions)
Markiert den angegebenen Blob oder die angegebene Momentaufnahme für den Löschvorgang, falls vorhanden. Das Blob wird später während der Garbage Collection gelöscht. Beachten Sie, dass Sie zum Löschen eines Blobs alle Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang "Blob löschen" löschen.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>
Parameter
- options
- BlobDeleteOptions
Optionale Optionen für blob Delete-Vorgang.
Gibt zurück
Promise<BlobDeleteIfExistsResponse>
Geerbt vonBlobClient.deleteIfExists
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Löschen Sie die Immutablilitätsrichtlinie für das Blob.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>
Parameter
Optionale Optionen zum Löschen der Unveränderlichkeitsrichtlinie für das Blob.
Gibt zurück
Promise<BlobDeleteImmutabilityPolicyResponse>
geerbt vonBlobClient.deleteImmutabilityPolicy
download(number, number, BlobDownloadOptions)
Liest oder lädt ein Blob aus dem System herunter, einschließlich seiner Metadaten und Eigenschaften. Sie können get Blob auch aufrufen, um eine Momentaufnahme zu lesen.
- In Node.jswerden Daten in einem lesbaren Stream lesbarStreamBody zurückgegeben.
- In Browsern werden Daten in einem Zusage blobBody zurückgegeben
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
Parameter
- offset
-
number
Von welcher Position des blob heruntergeladen werden soll, größer oder gleich 0
- count
-
number
Wie viele Daten heruntergeladen werden sollen, größer als 0. Wird am Ende heruntergeladen, wenn nicht definiert
- options
- BlobDownloadOptions
Optionale Optionen für den Blob-Downloadvorgang.
Beispielverwendung (Node.js):
// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());
async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}
Beispielverwendung (Browser):
// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
"Downloaded blob content",
downloaded
);
async function blobToString(blob: Blob): Promise<string> {
const fileReader = new FileReader();
return new Promise<string>((resolve, reject) => {
fileReader.onloadend = (ev: any) => {
resolve(ev.target!.result);
};
fileReader.onerror = reject;
fileReader.readAsText(blob);
});
}
Gibt zurück
Promise<BlobDownloadResponseParsed>
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)
NUR IN NODE.JS RUNTIME VERFÜGBAR.
Lädt ein Azure Blob parallel zu einem Puffer herunter. Offset und Anzahl sind optional, lädt das gesamte BLOB herunter, wenn sie nicht bereitgestellt werden.
Warnung: Puffer können Dateien nur bis zu einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen, da einschränkungen von Node.js/V8. Berücksichtigen Sie für Blobs, die größer als diese Größe sind, downloadToFile-.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Parameter
- buffer
-
Buffer
Puffer, der gefüllt werden soll, muss die Länge größer sein als die Anzahl
- offset
-
number
Von welcher Position des Block-Blobs heruntergeladen werden soll(in Bytes)
- count
-
number
Wie viele Daten(in Bytes) heruntergeladen werden sollen. Wird beim Übergeben von undefined auf das Ende heruntergeladen
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Gibt zurück
Promise<Buffer>
Geerbt vonBlobClient.downloadToBuffer-
downloadToBuffer(number, number, BlobDownloadToBufferOptions)
NUR IN NODE.JS RUNTIME VERFÜGBAR.
Lädt ein Azure Blob parallel zu einem Puffer herunter. Offset und Anzahl sind optional, lädt das gesamte BLOB herunter, wenn sie nicht bereitgestellt werden.
Warnung: Puffer können Dateien nur bis zu einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen, da einschränkungen von Node.js/V8. Berücksichtigen Sie für Blobs, die größer als diese Größe sind, downloadToFile-.
function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Parameter
- offset
-
number
Von welcher Position des Block-Blobs heruntergeladen werden soll(in Bytes)
- count
-
number
Wie viele Daten(in Bytes) heruntergeladen werden sollen. Wird beim Übergeben von undefined auf das Ende heruntergeladen
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Gibt zurück
Promise<Buffer>
Geerbt vonBlobClient.downloadToBuffer-
downloadToFile(string, number, number, BlobDownloadOptions)
NUR IN NODE.JS RUNTIME VERFÜGBAR.
Lädt ein Azure Blob in eine lokale Datei herunter. Schlägt fehl, wenn der angegebene Dateipfad bereits beendet wird. Offset und Anzahl sind optional, übergeben 0 und nicht definiert, um das gesamte Blob herunterzuladen.
function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
Parameter
- filePath
-
string
- offset
-
number
Von welcher Position des block-Blobs heruntergeladen werden soll.
- count
-
number
Wie viele Daten heruntergeladen werden sollen. Wird beim Übergeben undefiniert auf das Ende heruntergeladen.
- options
- BlobDownloadOptions
Optionen für Blob-Downloadoptionen.
Gibt zurück
Promise<BlobDownloadResponseParsed>
Die Antwortdaten für den Blob-Downloadvorgang, aber mit "readableStreamBody" auf "undefiniert", da der Inhalt bereits in eine lokale Datei im angegebenen Pfad gelesen und geschrieben wurde.
Geerbt vonBlobClient.downloadToFile-
exists(BlobExistsOptions)
Gibt "true" zurück, wenn die von diesem Client dargestellte Azure-Blobressource vorhanden ist. andernfalls "false".
HINWEIS: Verwenden Sie diese Funktion mit Bedacht, da ein vorhandenes BLOB möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Blobs von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen wurde.
function exists(options?: BlobExistsOptions): Promise<boolean>
Parameter
- options
- BlobExistsOptions
options to Exists operation.
Gibt zurück
Promise<boolean>
Geerbt vonBlobClient.exists
generateSasUrl(BlobGenerateSasUrlOptions)
Nur für BlobClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde.
Generiert einen SAS-URI (Blob Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>
Parameter
- options
- BlobGenerateSasUrlOptions
Optionale Parameter.
Gibt zurück
Promise<string>
Der SAS-URI, der aus dem URI für die Ressource besteht, die von diesem Client dargestellt wird, gefolgt vom generierten SAS-Token.
geerbt vonBlobClient.generateSasUrl-
getAccountInfo(BlobGetAccountInfoOptions)
Der Vorgang "Kontoinformationen abrufen" gibt den SKU-Namen und die Kontoart für das angegebene Konto zurück. Der Vorgang "Kontoinformationen abrufen" ist in Dienstversionen ab Version 2018-03-28 verfügbar.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
function getAccountInfo(options?: BlobGetAccountInfoOptions): Promise<BlobGetAccountInfoResponse>
Parameter
- options
- BlobGetAccountInfoOptions
Optionen für den Service Get Account Info-Vorgang.
Gibt zurück
Promise<BlobGetAccountInfoResponse>
Antwortdaten für den Service Get Account Info-Vorgang.
Geerbt vonBlobClient.getAccountInfo
getAppendBlobClient()
Erstellt ein AppendBlobClient -Objekt.
function getAppendBlobClient(): AppendBlobClient
Gibt zurück
geerbt vonBlobClient.getAppendBlobClient-
getBlobLeaseClient(string)
Rufen Sie eine BlobLeaseClient- ab, die Leases für das Blob verwaltet.
function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient
Parameter
- proposeLeaseId
-
string
Anfänglich vorgeschlagene Lease-ID.
Gibt zurück
Ein neues BlobLeaseClient-Objekt zum Verwalten von Leases für das Blob.
Geerbt vonBlobClient.getBlobLeaseClient-
getBlockBlobClient()
Erstellt ein BlockBlobClient -Objekt.
function getBlockBlobClient(): BlockBlobClient
Gibt zurück
geerbt vonBlobClient.getBlockBlobClient-
getPageBlobClient()
Erstellt ein PageBlobClient -Objekt.
function getPageBlobClient(): PageBlobClient
Gibt zurück
geerbt vonBlobClient.getPageBlobClient
getProperties(BlobGetPropertiesOptions)
Gibt alle benutzerdefinierten Metadaten, Standard-HTTP-Eigenschaften und Systemeigenschaften für das Blob zurück. Der Inhalt des BLOB wird nicht zurückgegeben.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
WARNUNG: Das in der Antwort zurückgegebene metadata
-Objekt weist die Schlüssel in Kleinbuchstaben auf, auch wenn sie ursprünglich Großbuchstaben enthielten. Dies unterscheidet sich von den Metadatenschlüsseln, die von den Methoden von ContainerClient, die Blobs mithilfe der option includeMetadata
auflisten, die ihre ursprüngliche Groß-/Kleinschreibung beibehalten.
function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>
Parameter
- options
- BlobGetPropertiesOptions
Optionale Optionen zum Abrufen des Eigenschaftenvorgangs.
Gibt zurück
Promise<BlobGetPropertiesResponse>
Geerbt vonBlobClient.getProperties-
getTags(BlobGetTagsOptions)
Ruft die Tags ab, die dem zugrunde liegenden Blob zugeordnet sind.
function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>
Parameter
- options
- BlobGetTagsOptions
Gibt zurück
Promise<BlobGetTagsResponse>
setAccessTier(string, BlobSetTierOptions)
Legt die Ebene für ein Blob fest. Der Vorgang ist in einem Seiten-BLOB in einem Premium-Speicherkonto und in einem Block-Blob in einem Blob-Speicherkonto zulässig (nur lokal redundanter Speicher). Die Ebene eines Premiumseiten-Blobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Block-BLOB bestimmt den Speichertyp "Hot/Cool/Archive". Dieser Vorgang aktualisiert das ETag des BLOB nicht.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>
Parameter
- tier
-
string
Die Ebene, die für das Blob festgelegt werden soll. Gültige Werte sind Hot, Cool oder Archive.
- options
- BlobSetTierOptions
Optionale Optionen für den Blob Set Tier-Vorgang.
Gibt zurück
Promise<BlobSetTierResponse>
Geerbt vonBlobClient.setAccessTier-
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)
Legt Systemeigenschaften für das Blob fest.
Wenn kein Wert angegeben oder kein Wert für die angegebenen BLOB-HTTP-Header bereitgestellt wird, werden diese BLOB-HTTP-Header ohne einen Wert gelöscht.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>
Parameter
- blobHTTPHeaders
- BlobHTTPHeaders
Wenn kein Wert angegeben oder kein Wert für die angegebenen BLOB-HTTP-Header bereitgestellt wird, werden diese BLOB-HTTP-Header ohne einen Wert gelöscht.
Eine allgemeine Kopfzeile, die festgelegt werden soll, ist blobContentType
, die es dem Browser ermöglicht, Funktionen basierend auf dem Dateityp bereitzustellen.
- options
- BlobSetHTTPHeadersOptions
Optionale Optionen für den VORGANG "BLOB Set HTTP Headers".
Gibt zurück
Promise<BlobSetHTTPHeadersResponse>
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Legen Sie die Unveränderlichkeitsrichtlinie für das Blob fest.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>
Parameter
- immutabilityPolicy
- BlobImmutabilityPolicy
- options
- BlobSetImmutabilityPolicyOptions
Optionale Optionen zum Festlegen der Unveränderlichkeitsrichtlinie für das Blob.
Gibt zurück
Promise<BlobSetImmutabilityPolicyResponse>
Geerbt vonBlobClient.setImmutabilityPolicy
setLegalHold(boolean, BlobSetLegalHoldOptions)
Legen Sie den gesetzlichen Halteraum für das Blob fest.
function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>
Parameter
- legalHoldEnabled
-
boolean
- options
- BlobSetLegalHoldOptions
Optionale Optionen zum Festlegen des gesetzlichen Halteraums für das Blob.
Gibt zurück
Promise<BlobSetLegalHoldResponse>
geerbt vonBlobClient.setLegalHold
setMetadata(Metadata, BlobSetMetadataOptions)
Legt benutzerdefinierte Metadaten für das angegebene Blob als ein oder mehrere Name-Wert-Paare fest.
Wenn im Parameter keine Option angegeben oder keine Metadaten definiert sind, werden die BLOB-Metadaten entfernt.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>
Parameter
- metadata
- Metadata
Ersetzen Sie vorhandene Metadaten durch diesen Wert. Wenn kein Wert bereitgestellt wird, werden die vorhandenen Metadaten entfernt.
- options
- BlobSetMetadataOptions
Optionale Optionen zum Festlegen des Metadatenvorgangs.
Gibt zurück
Promise<BlobSetMetadataResponse>
geerbt vonBlobClient.setMetadata-
setTags(Tags, BlobSetTagsOptions)
Legt Tags für das zugrunde liegende Blob fest. Ein Blob kann bis zu 10 Tags aufweisen. Tagtasten müssen zwischen 1 und 128 Zeichen bestehen. Tagwerte müssen zwischen 0 und 256 Zeichen bestehen. Gültige Tagschlüssel- und Wertzeichen umfassen Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen (' '), Pluszeichen ('+'), Minuszeichen ('-'), Punkt ('.'), Schrägstrich ('/'), Doppelpunkt (':'), gleich ('=') und Unterstrich ('_').
function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>
Parameter
- tags
- Tags
- options
- BlobSetTagsOptions
Gibt zurück
Promise<BlobSetTagsResponse>
Geerbt vonBlobClient.setTags
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)
Der synchrone Kopiervorgang von URL kopiert ein BLOB oder eine Internetressource in ein neues Blob. Sie gibt erst dann eine Antwort zurück, wenn die Kopie abgeschlossen ist.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>
Parameter
- copySource
-
string
Die Quell-URL, aus der kopiert werden soll, ist möglicherweise für die Authentifizierung erforderlich.
- options
- BlobSyncCopyFromURLOptions
Gibt zurück
Promise<BlobCopyFromURLResponse>
geerbt vonBlobClient.syncCopyFromURL-
undelete(BlobUndeleteOptions)
Stellt den Inhalt und die Metadaten eines vorläufig gelöschten Blobs und alle zugeordneten vorläufig gelöschten Momentaufnahmen wieder her. Undelete Blob wird nur unter Version 2017-07-29 oder höher unterstützt.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>
Parameter
- options
- BlobUndeleteOptions
Optionale Optionen für blob Undelete-Vorgang.
Gibt zurück
Promise<BlobUndeleteResponse>
geerbt vonBlobClient.undelete
withVersion(string)
Erstellt ein neues BlobClient -Objekt, das auf eine Version dieses Blob zeigt. Geben Sie "" entfernt die versionId und gibt einen Client an das Basis-Blob zurück.
function withVersion(versionId: string): BlobClient
Parameter
- versionId
-
string
Die versionId.
Gibt zurück
Ein neues BlobClient-Objekt, das auf die Version dieses Blob verweist.
geerbt vonBlobClient.withVersion