AppendBlobClient class
AppendBlobClient definieert een set bewerkingen die van toepassing zijn op toevoeg-blobs.
- Extends
Constructors
| Append |
Hiermee maakt u een instantie van AppendBlobClient. Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een toevoeg-blob. De gecodeerde URL-tekenreeks wordt NIET twee keer ge escaped, alleen speciale tekens in het URL-pad worden ge escaped. Als een blobnaam ? of %, moet de blobnaam zijn gecodeerd in de URL. |
| Append |
Hiermee maakt u een instantie van AppendBlobClient. Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een toevoeg-blob. De gecodeerde URL-tekenreeks wordt NIET twee keer ge escaped, alleen speciale tekens in het URL-pad worden ge escaped. Als een blobnaam ? of %, moet de blobnaam zijn gecodeerd in de URL. |
| Append |
Hiermee maakt u een instantie van AppendBlobClient. |
Eigenschappen
| account |
|
| container |
De naam van de opslagcontainer waar de blob aan is gekoppeld. |
| credential | Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het |
| name | De naam van de blob. |
| url | Gecodeerde URL-tekenreekswaarde. |
Methoden
| abort |
Hiermee wordt een in behandeling zijnde asynchrone copy blob-bewerking afgebroken en blijft een doel-blob met de lengte nul en volledige metagegevens behouden. Versie 2012-02-12 en hoger. |
| append |
Hiermee wordt een nieuw gegevensblok doorgevoerd aan het einde van de bestaande toevoeg-blob. |
| append |
Met de bewerking Toevoegblok wordt een nieuw gegevensblok doorgevoerd aan het einde van een bestaande toevoeg-blob, waarbij de inhoud wordt gelezen uit een bron-URL. |
| begin |
Een blob wordt asynchroon gekopieerd naar een bestemming binnen het opslagaccount.
Deze methode retourneert een langlopende bewerking poller waarmee u voor onbepaalde tijd kunt wachten totdat het kopiëren is voltooid.
U kunt een kopie ook annuleren voordat deze is voltooid door aan te roepen |
| create(Append |
Hiermee maakt u een toevoeg-blob van 0 lengte. Roep AppendBlock aan om gegevens toe te voegen aan een toevoeg-blob. |
| create |
Hiermee maakt u een toevoeg-blob van 0 lengte. Roep AppendBlock aan om gegevens toe te voegen aan een toevoeg-blob. Als de blob met dezelfde naam al bestaat, blijft de inhoud van de bestaande blob ongewijzigd. |
| create |
Hiermee maakt u een alleen-lezen momentopname van een blob. |
| delete(Blob |
Markeert de opgegeven blob of momentopname voor verwijdering. De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen. |
| delete |
Markeert de opgegeven blob of momentopname voor verwijdering als deze bestaat. De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen. |
| delete |
Verwijder het beleid immutablility op de blob. |
| download(number, number, Blob |
Leest of downloadt een blob uit het systeem, inclusief de metagegevens en eigenschappen. U kunt ook Blob ophalen aanroepen om een momentopname te lezen.
|
| download |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure-blob parallel met een buffer. Offset en count zijn optioneel. De volledige blob wordt gedownload als deze niet is opgegeven. Waarschuwing: Buffers kunnen alleen bestanden ondersteunen tot ongeveer één gigabyte op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor blobs die groter zijn dan deze grootte, kunt u overwegen <xref:downloadToFile>. |
| download |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure-blob parallel aan een buffer. Offset en count zijn optioneel. De volledige blob wordt gedownload als deze niet zijn opgegeven. Waarschuwing: Buffers kunnen alleen bestanden ondersteunen tot ongeveer één gigabyte op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor blobs die groter zijn dan deze grootte, kunt u overwegen <xref:downloadToFile>. |
| download |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure-blob naar een lokaal bestand. Mislukt als het opgegeven bestandspad al wordt afgesloten. Offset en aantal zijn optioneel, geef respectievelijk 0 en undefined door om de hele blob te downloaden. |
| exists(Blob |
Retourneert true als de Azure-blobresource die wordt vertegenwoordigd door deze client bestaat; anders onwaar. OPMERKING: gebruik deze functie zorgvuldig, omdat een bestaande blob mogelijk door andere clients of toepassingen wordt verwijderd. Omgekeerd kunnen nieuwe blobs worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid. |
| generate |
Alleen beschikbaar voor BlobClient die is samengesteld met een gedeelde sleutelreferentie. Hiermee wordt een SAS-URI (Shared Access Signature) voor Blob Service gegenereerd op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client. |
| get |
Hiermee maakt u een AppendBlobClient-object. |
| get |
Haal een <xref:BlobLeaseClient> op die leases op de blob beheert. |
| get |
Hiermee maakt u een BlockBlobClient-object. |
| get |
Hiermee maakt u een PageBlobClient-object. |
| get |
Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard-HTTP-eigenschappen en systeemeigenschappen voor de blob. De inhoud van de blob wordt niet geretourneerd. |
| get |
Hiermee haalt u de tags op die zijn gekoppeld aan de onderliggende blob. |
| seal(Append |
Hiermee verzegelt u de toevoeg-blob, zodat deze alleen-lezen is. |
| set |
Hiermee stelt u de laag op een blob in. De bewerking is toegestaan op een pagina-blob in een Premium-opslagaccount en op een blok-blob in een blob-opslagaccount (alleen lokaal redundante opslag). De laag van een Premium-pagina-blob bepaalt de toegestane grootte, IOPS en bandbreedte van de blob. De laag van een blok-blob bepaalt het opslagtype Dynamisch/Statisch/Archief. Met deze bewerking wordt de ETag van de blob niet bijgewerkt. |
| set |
Hiermee stelt u systeemeigenschappen in op de blob. Als er geen waarde is opgegeven of als er geen waarde is opgegeven voor de opgegeven blob-HTTP-headers, worden deze blob-HTTP-headers zonder een waarde gewist. |
| set |
Stel immutablility-beleid in op de blob. |
| set |
Stel juridische bewaring in voor de blob. |
| set |
Hiermee stelt u door de gebruiker gedefinieerde metagegevens voor de opgegeven blob in als een of meer naam-waardeparen. Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de parameter, worden de metagegevens van de blob verwijderd. |
| set |
Hiermee stelt u tags in op de onderliggende blob. Een blob kan maximaal 10 tags bevatten. Tagsleutels moeten tussen 1 en 128 tekens zijn. Tagwaarden moeten tussen 0 en 256 tekens zijn. Geldige tagsleutel- en waardetekens zijn kleine en hoofdletters, cijfers (0-9), spatie (' '), plusteken ('+'), minteken ('-'), punt ('.'), slash ('/'), dubbele punt (':'), gelijk aan ('='), en onderstrepingsteken ('_') . |
| sync |
Met de synchrone bewerking Kopiëren van URL kopieert u een blob of een internetbron naar een nieuwe blob. Er wordt pas een antwoord geretourneerd als het kopiëren is voltooid. |
| undelete(Blob |
Herstelt de inhoud en metagegevens van voorlopig verwijderde blob en eventuele bijbehorende voorlopig verwijderde momentopnamen. Verwijderen van blob ongedaan maken wordt alleen ondersteund op versie 29-07-2017 of hoger. |
| with |
Hiermee maakt u een nieuw AppendBlobClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel van de momentopname. Geef op om de momentopname te verwijderen en een client terug te keren naar de basis-blob. |
| with |
Hiermee maakt u een nieuw BlobClient-object dat verwijst naar een versie van deze blob. Geef op: hiermee wordt de versionId verwijderd en wordt een client geretourneerd naar de basis-blob. |
Constructordetails
AppendBlobClient(string, PipelineLike)
Hiermee maakt u een instantie van AppendBlobClient. Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een toevoeg-blob. De gecodeerde URL-tekenreeks wordt NIET twee keer ge escaped, alleen speciale tekens in het URL-pad worden ge escaped. Als een blobnaam ? of %, moet de blobnaam zijn gecodeerd in de URL.
new AppendBlobClient(url: string, pipeline: PipelineLike)Parameters
- url
-
string
Een URL-tekenreeks die verwijst naar de toevoeg-blob van Azure Storage, zoals 'https://myaccount.blob.core.windows.net/mycontainer/appendblob". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een blob. De gecodeerde URL-tekenreeks wordt NIET twee keer ge escaped, alleen speciale tekens in het URL-pad worden ge escaped. Als een blobnaam echter ? of %, moet de blobnaam zijn gecodeerd in de URL. Zoals een blob met de naam 'my?blob%', moet de URL 'https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"' zijn.
- pipeline
- PipelineLike
Roep newPipeline() aan om een standaardpijplijn te maken of een aangepaste pijplijn op te geven.
AppendBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Hiermee maakt u een instantie van AppendBlobClient. Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een toevoeg-blob. De gecodeerde URL-tekenreeks wordt NIET twee keer ge escaped, alleen speciale tekens in het URL-pad worden ge escaped. Als een blobnaam ? of %, moet de blobnaam zijn gecodeerd in de URL.
new AppendBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)Parameters
- url
-
string
Een URL-tekenreeks die verwijst naar de toevoeg-blob van Azure Storage, zoals 'https://myaccount.blob.core.windows.net/mycontainer/appendblob". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een blob. De gecodeerde URL-tekenreeks wordt NIET twee keer ge escaped, alleen speciale tekens in het URL-pad worden ge escaped. Als een blobnaam echter ? of %, moet de blobnaam zijn gecodeerd in de URL. Zoals een blob met de naam 'my?blob%', moet de URL 'https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"' zijn.
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.
- options
- StoragePipelineOptions
Optioneel. Opties voor het configureren van de HTTP-pijplijn.
AppendBlobClient(string, string, string, StoragePipelineOptions)
Hiermee maakt u een instantie van AppendBlobClient.
new AppendBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)Parameters
- connectionString
-
string
Account connection string of een SAS-connection string van een Azure-opslagaccount.
[ Opmerking: account connection string kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van account connection string -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.netVoorbeeld van SAS-connection string -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
Containernaam.
- blobName
-
string
Blobnaam.
- options
- StoragePipelineOptions
Optioneel. Opties voor het configureren van de HTTP-pijplijn.
Eigenschapdetails
accountName
accountName: stringWaarde van eigenschap
string
containerName
De naam van de opslagcontainer waar de blob aan is gekoppeld.
string containerNameWaarde van eigenschap
string
credential
Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de interface TokenCredential wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredentialWaarde van eigenschap
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
name
De naam van de blob.
string nameWaarde van eigenschap
string
url
Gecodeerde URL-tekenreekswaarde.
url: stringWaarde van eigenschap
string
Methodedetails
abortCopyFromURL(string, BlobAbortCopyFromURLOptions)
Hiermee wordt een in behandeling zijnde asynchrone copy blob-bewerking afgebroken en blijft een doel-blob met de lengte nul en volledige metagegevens behouden. Versie 2012-02-12 en hoger.
function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)Parameters
- copyId
-
string
Id van de bewerking Copy From URL.
- options
- BlobAbortCopyFromURLOptions
Optionele opties voor de bewerking Blob Afgebroken Kopiëren van URL.
Retouren
Promise<BlobAbortCopyFromURLResponse>
appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)
Hiermee wordt een nieuw gegevensblok doorgevoerd aan het einde van de bestaande toevoeg-blob.
function appendBlock(body: HttpRequestBody, contentLength: number, options?: AppendBlobAppendBlockOptions)Parameters
- body
-
HttpRequestBody
Gegevens die moeten worden toegevoegd.
- contentLength
-
number
Lengte van de hoofdtekst in bytes.
- options
- AppendBlobAppendBlockOptions
Opties voor de bewerking Toevoegblok.
Gebruiksvoorbeeld:
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);
Retouren
Promise<AppendBlobAppendBlockResponse>
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)
Met de bewerking Toevoegblok wordt een nieuw gegevensblok doorgevoerd aan het einde van een bestaande toevoeg-blob, waarbij de inhoud wordt gelezen uit een bron-URL.
function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions)Parameters
- sourceURL
-
string
-
The url to the blob that will be the source of the copy. A source blob in the same storage account can be authenticated via Shared Key. However, if the source is a blob in another account, the source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the operation.
- sourceOffset
-
number
Verschuiving in bron die moet worden toegevoegd
- count
-
number
Aantal bytes dat als blok moet worden toegevoegd
Retouren
Promise<AppendBlobAppendBlockFromUrlResponse>
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)
Een blob wordt asynchroon gekopieerd naar een bestemming binnen het opslagaccount.
Deze methode retourneert een langlopende bewerking poller waarmee u voor onbepaalde tijd kunt wachten totdat het kopiëren is voltooid.
U kunt een kopie ook annuleren voordat deze is voltooid door aan te roepen cancelOperation op de poller.
Houd er rekening mee dat de callback onProgress niet wordt aangeroepen als de bewerking in de eerste aanvraag is voltooid. Als u probeert een voltooide kopie te annuleren, wordt er een fout gegenereerd.
In versie 2012-02-12 en hoger kan de bron voor een Copy Blob-bewerking een vastgelegde blob in elk Azure-opslagaccount zijn.
Vanaf versie 2015-02-21 kan de bron voor een kopieerblobbewerking een Azure-bestand in elk Azure-opslagaccount zijn.
Alleen opslagaccounts die op of na 7 juni 2012 zijn gemaakt, staan de bewerking Blob kopiëren toe om te kopiëren vanuit een ander opslagaccount.
function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)Parameters
- copySource
-
string
url naar de bron-Azure Blob/File.
- options
- BlobBeginCopyFromURLOptions
Optionele opties voor de bewerking Blob Kopiëren van URL starten.
Retouren
Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
create(AppendBlobCreateOptions)
Hiermee maakt u een toevoeg-blob van 0 lengte. Roep AppendBlock aan om gegevens toe te voegen aan een toevoeg-blob.
function create(options?: AppendBlobCreateOptions)Parameters
- options
- AppendBlobCreateOptions
Opties voor de bewerking Toevoegblok maken.
Gebruiksvoorbeeld:
const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();
Retouren
Promise<AppendBlobCreateResponse>
createIfNotExists(AppendBlobCreateIfNotExistsOptions)
Hiermee maakt u een toevoeg-blob van 0 lengte. Roep AppendBlock aan om gegevens toe te voegen aan een toevoeg-blob. Als de blob met dezelfde naam al bestaat, blijft de inhoud van de bestaande blob ongewijzigd.
function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions)Parameters
Retouren
Promise<AppendBlobCreateIfNotExistsResponse>
createSnapshot(BlobCreateSnapshotOptions)
Hiermee maakt u een alleen-lezen momentopname van een blob.
function createSnapshot(options?: BlobCreateSnapshotOptions)Parameters
- options
- BlobCreateSnapshotOptions
Optionele opties voor de bewerking Blob-momentopname maken.
Retouren
Promise<BlobCreateSnapshotResponse>
delete(BlobDeleteOptions)
Markeert de opgegeven blob of momentopname voor verwijdering. De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen.
function delete(options?: BlobDeleteOptions)Parameters
- options
- BlobDeleteOptions
Optionele opties voor de bewerking Blob verwijderen.
Retouren
Promise<BlobDeleteResponse>
deleteIfExists(BlobDeleteOptions)
Markeert de opgegeven blob of momentopname voor verwijdering als deze bestaat. De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen.
function deleteIfExists(options?: BlobDeleteOptions)Parameters
- options
- BlobDeleteOptions
Optionele opties voor de bewerking Blob verwijderen.
Retouren
Promise<BlobDeleteIfExistsResponse>
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Verwijder het beleid immutablility op de blob.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)Parameters
Optionele opties voor het verwijderen van beleid voor onveranderbaarheid op de blob.
Retouren
Promise<BlobDeleteImmutabilityPolicyResponse>
download(number, number, BlobDownloadOptions)
Leest of downloadt een blob uit het systeem, inclusief de metagegevens en eigenschappen. U kunt ook Blob ophalen aanroepen om een momentopname te lezen.
- In Node.js worden gegevens geretourneerd in een leesbare stream die kan worden gelezenStreamBody
- In browsers worden gegevens geretourneerd in een promise blobBody
function download(offset?: number, count?: number, options?: BlobDownloadOptions)Parameters
- offset
-
number
Vanaf welke positie van de blob die moet worden gedownload, groter dan of gelijk aan 0
- count
-
number
Hoeveel gegevens er moeten worden gedownload, groter dan 0. Wordt tot het einde gedownload wanneer deze niet is gedefinieerd
- options
- BlobDownloadOptions
Optionele opties voor de blobdownloadbewerking.
Voorbeeld van gebruik (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);
});
}
Voorbeeld van gebruik (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);
});
}
Retouren
Promise<BlobDownloadResponseParsed>
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure-blob parallel met een buffer. Offset en count zijn optioneel. De volledige blob wordt gedownload als deze niet is opgegeven.
Waarschuwing: Buffers kunnen alleen bestanden ondersteunen tot ongeveer één gigabyte op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor blobs die groter zijn dan deze grootte, kunt u overwegen <xref:downloadToFile>.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions)Parameters
- buffer
-
Buffer
Buffer die moet worden gevuld, moet een lengte hebben die groter is dan het aantal
- offset
-
number
Vanaf welke positie van de blok-blob moet worden gedownload (in bytes)
- count
-
number
Hoeveel gegevens (in bytes) moeten worden gedownload. Wordt tot het einde gedownload bij het doorgeven van niet-gedefinieerde
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Retouren
Promise<Buffer>
downloadToBuffer(number, number, BlobDownloadToBufferOptions)
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure-blob parallel aan een buffer. Offset en count zijn optioneel. De volledige blob wordt gedownload als deze niet zijn opgegeven.
Waarschuwing: Buffers kunnen alleen bestanden ondersteunen tot ongeveer één gigabyte op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor blobs die groter zijn dan deze grootte, kunt u overwegen <xref:downloadToFile>.
function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)Parameters
- offset
-
number
Vanaf welke positie van de blok-blob moet worden gedownload (in bytes)
- count
-
number
Hoeveel gegevens (in bytes) moeten worden gedownload. Wordt gedownload tot het einde wanneer undefined wordt doorgegeven
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Retouren
Promise<Buffer>
downloadToFile(string, number, number, BlobDownloadOptions)
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure-blob naar een lokaal bestand. Mislukt als het opgegeven bestandspad al wordt afgesloten. Offset en aantal zijn optioneel, geef respectievelijk 0 en undefined door om de hele blob te downloaden.
function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)Parameters
- filePath
-
string
- offset
-
number
Vanaf welke positie van de blok-blob moet worden gedownload.
- count
-
number
Hoeveel gegevens er moeten worden gedownload. Wordt gedownload tot het einde wanneer undefined wordt doorgegeven.
- options
- BlobDownloadOptions
Opties voor blobdownloadopties.
Retouren
Promise<BlobDownloadResponseParsed>
De reactiegegevens voor de blobdownloadbewerking, maar met readableStreamBody ingesteld op undefined omdat de inhoud al is gelezen en geschreven in een lokaal bestand op het opgegeven pad.
exists(BlobExistsOptions)
Retourneert true als de Azure-blobresource die wordt vertegenwoordigd door deze client bestaat; anders onwaar. OPMERKING: gebruik deze functie zorgvuldig, omdat een bestaande blob mogelijk door andere clients of toepassingen wordt verwijderd. Omgekeerd kunnen nieuwe blobs worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.
function exists(options?: BlobExistsOptions)Parameters
- options
- BlobExistsOptions
opties voor de bewerking Exists.
Retouren
Promise<boolean>
generateSasUrl(BlobGenerateSasUrlOptions)
Alleen beschikbaar voor BlobClient die is samengesteld met een gedeelde sleutelreferentie. Hiermee wordt een SAS-URI (Shared Access Signature) voor Blob Service gegenereerd op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.
function generateSasUrl(options: BlobGenerateSasUrlOptions)Parameters
- options
- BlobGenerateSasUrlOptions
Optionele parameters.
Retouren
Promise<string>
De SAS-URI die bestaat uit de URI naar de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.
getAppendBlobClient()
Hiermee maakt u een AppendBlobClient-object.
function getAppendBlobClient()Retouren
getBlobLeaseClient(string)
Haal een <xref:BlobLeaseClient> op die leases op de blob beheert.
function getBlobLeaseClient(proposeLeaseId?: string)Parameters
- proposeLeaseId
-
string
Initiële voorgestelde lease-id.
Retouren
Een nieuw BlobLeaseClient-object voor het beheren van leases op de blob.
getBlockBlobClient()
getPageBlobClient()
getProperties(BlobGetPropertiesOptions)
Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard-HTTP-eigenschappen en systeemeigenschappen voor de blob. De inhoud van de blob wordt niet geretourneerd.
function getProperties(options?: BlobGetPropertiesOptions)Parameters
- options
- BlobGetPropertiesOptions
Optionele opties voor de bewerking Eigenschappen ophalen.
Retouren
Promise<BlobGetPropertiesResponse>
getTags(BlobGetTagsOptions)
Hiermee haalt u de tags op die zijn gekoppeld aan de onderliggende blob.
function getTags(options?: BlobGetTagsOptions)Parameters
- options
- BlobGetTagsOptions
Retouren
Promise<BlobGetTagsResponse>
seal(AppendBlobSealOptions)
Hiermee verzegelt u de toevoeg-blob, zodat deze alleen-lezen is.
function seal(options?: AppendBlobSealOptions)Parameters
- options
- AppendBlobSealOptions
Retouren
Promise<AppendBlobAppendBlockResponse>
setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)
Hiermee stelt u de laag op een blob in. De bewerking is toegestaan op een pagina-blob in een Premium-opslagaccount en op een blok-blob in een blob-opslagaccount (alleen lokaal redundante opslag). De laag van een Premium-pagina-blob bepaalt de toegestane grootte, IOPS en bandbreedte van de blob. De laag van een blok-blob bepaalt het opslagtype Dynamisch/Statisch/Archief. Met deze bewerking wordt de ETag van de blob niet bijgewerkt.
function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)Parameters
- tier
-
BlockBlobTier | PremiumPageBlobTier | string
De laag die moet worden ingesteld op de blob. Geldige waarden zijn Dynamisch, Statisch of Archief.
- options
- BlobSetTierOptions
Optionele opties voor de bewerking Blob-laag instellen.
Retouren
Promise<BlobSetTierResponse>
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)
Hiermee stelt u systeemeigenschappen in op de blob. Als er geen waarde is opgegeven of als er geen waarde is opgegeven voor de opgegeven blob-HTTP-headers, worden deze blob-HTTP-headers zonder een waarde gewist.
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)Parameters
- blobHTTPHeaders
- BlobHTTPHeaders
Als er geen waarde is opgegeven of als er geen waarde is opgegeven voor de opgegeven blob-HTTP-headers, worden deze blob-HTTP-headers zonder een waarde gewist.
Een veelgebruikte header die moet worden ingesteld, is blobContentType dat de browser functionaliteit kan bieden op basis van het bestandstype.
- options
- BlobSetHTTPHeadersOptions
Optionele opties voor de bewerking HTTP-headers instellen in blob.
Retouren
Promise<BlobSetHTTPHeadersResponse>
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Stel immutablility-beleid in op de blob.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)Parameters
- immutabilityPolicy
- BlobImmutabilityPolicy
- options
- BlobSetImmutabilityPolicyOptions
Optionele opties voor het instellen van beleid voor onveranderbaarheid op de blob.
Retouren
Promise<BlobSetImmutabilityPolicyResponse>
setLegalHold(boolean, BlobSetLegalHoldOptions)
Stel juridische bewaring in voor de blob.
function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions)Parameters
- legalHoldEnabled
-
boolean
- options
- BlobSetLegalHoldOptions
Optionele opties voor het instellen van juridische bewaring voor de blob.
Retouren
Promise<BlobSetLegalHoldResponse>
setMetadata(Metadata, BlobSetMetadataOptions)
Hiermee stelt u door de gebruiker gedefinieerde metagegevens voor de opgegeven blob in als een of meer naam-waardeparen. Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de parameter, worden de metagegevens van de blob verwijderd.
function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)Parameters
- metadata
- Metadata
Vervang bestaande metagegevens door deze waarde. Als er geen waarde is opgegeven, worden de bestaande metagegevens verwijderd.
- options
- BlobSetMetadataOptions
Optionele opties voor de bewerking Metagegevens instellen.
Retouren
Promise<BlobSetMetadataResponse>
setTags(Tags, BlobSetTagsOptions)
Hiermee stelt u tags in op de onderliggende blob. Een blob kan maximaal 10 tags bevatten. Tagsleutels moeten tussen 1 en 128 tekens zijn. Tagwaarden moeten tussen 0 en 256 tekens zijn. Geldige tagsleutel- en waardetekens zijn kleine en hoofdletters, cijfers (0-9), spatie (' '), plusteken ('+'), minteken ('-'), punt ('.'), slash ('/'), dubbele punt (':'), gelijk aan ('='), en onderstrepingsteken ('_') .
function setTags(tags: Tags, options?: BlobSetTagsOptions)Parameters
- tags
- Tags
- options
- BlobSetTagsOptions
Retouren
Promise<BlobSetTagsResponse>
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)
Met de synchrone bewerking Kopiëren van URL kopieert u een blob of een internetbron naar een nieuwe blob. Er wordt pas een antwoord geretourneerd als het kopiëren is voltooid.
function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)Parameters
- copySource
-
string
De bron-URL van waaruit u wilt kopiëren, Shared Access Signature (SAS) is mogelijk nodig voor verificatie
- options
- BlobSyncCopyFromURLOptions
Retouren
Promise<BlobCopyFromURLResponse>
undelete(BlobUndeleteOptions)
Herstelt de inhoud en metagegevens van voorlopig verwijderde blob en eventuele bijbehorende voorlopig verwijderde momentopnamen. Verwijderen van blob ongedaan maken wordt alleen ondersteund op versie 29-07-2017 of hoger.
function undelete(options?: BlobUndeleteOptions)Parameters
- options
- BlobUndeleteOptions
Optionele opties voor de bewerking Blob ongedaan maken.
Retouren
Promise<BlobUndeleteResponse>
withSnapshot(string)
Hiermee maakt u een nieuw AppendBlobClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel van de momentopname. Geef op om de momentopname te verwijderen en een client terug te keren naar de basis-blob.
function withSnapshot(snapshot: string)Parameters
- snapshot
-
string
Het tijdstempel van de momentopname.
Retouren
Een nieuw AppendBlobClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel van de momentopname.
withVersion(string)
Hiermee maakt u een nieuw BlobClient-object dat verwijst naar een versie van deze blob. Geef op: hiermee wordt de versionId verwijderd en wordt een client geretourneerd naar de basis-blob.
function withVersion(versionId: string)Parameters
- versionId
-
string
De versionId.
Retouren
Een nieuw BlobClient-object dat verwijst naar de versie van deze blob.
Azure SDK for JavaScript
Feedback
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie: https://aka.ms/ContentUserFeedback.
Feedback verzenden en weergeven voor