AppendBlobClient class
AppendBlobClient definierar en uppsättning åtgärder som gäller för tilläggsblobar.
- Extends
Konstruktorer
Append |
Skapar en instans av AppendBlobClient. Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en tilläggsblob. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Om ett blobnamn innehåller ? eller %, blobnamnet måste vara kodat i URL:en. |
Append |
Skapar en instans av AppendBlobClient. Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en tilläggsblob. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Om ett blobnamn innehåller ? eller %, blobnamnet måste vara kodat i URL:en. |
Append |
Skapar en instans av AppendBlobClient. |
Egenskaper
container |
Namnet på lagringscontainern som bloben är associerad med. |
name | Namnet på bloben. |
Ärvda egenskaper
account |
|
credential | Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera |
url | Kodat URL-strängvärde. |
Metoder
append |
Genomför ett nytt datablock i slutet av den befintliga tilläggsbloben. Se https://docs.microsoft.com/rest/api/storageservices/append-block |
append |
Åtgärden Lägg till block checkar in ett nytt datablock i slutet av en befintlig tilläggsblob där innehållet läse från en käll-URL. Se https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url |
create(Append |
Skapar en tilläggsblob med 0 längder. Anropa AppendBlock för att lägga till data i en tilläggsblob. Se https://docs.microsoft.com/rest/api/storageservices/put-blob |
create |
Skapar en tilläggsblob med 0 längder. Anropa AppendBlock för att lägga till data i en tilläggsblob. Om bloben med samma namn redan finns förblir innehållet i den befintliga bloben oförändrat. Se https://docs.microsoft.com/rest/api/storageservices/put-blob |
seal(Append |
Förseglar tilläggsbloben, vilket gör den skrivskyddad. |
with |
Skapar ett nytt AppendBlobClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilder. Ange "" tar bort ögonblicksbilden och returnerar en klient till basbloben. |
Ärvda metoder
abort |
Avbryter en väntande asynkron kopieringsblobåtgärd och lämnar en målblob med noll längd och fullständiga metadata. Version 2012-02-12 och senare. Se https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob |
begin |
Kopierar asynkront en blob till ett mål i lagringskontot.
Den här metoden returnerar en tidskrävande åtgärdsmätning som gör att du kan vänta på obestämd tid tills kopieringen har slutförts.
Du kan också avbryta en kopia innan den är klar genom att anropa I version 2012-02-12 och senare kan källan för en kopieringsblobåtgärd vara en checkad blob i alla Azure Storage-konton. Från och med version 2015-02-21 kan källan för en kopieringsblobåtgärd vara en Azure-fil i valfritt Azure-lagringskonto. Endast lagringskonton som skapats den 7 juni 2012 eller senare tillåter kopieringsblobåtgärden att kopiera från ett annat lagringskonto. Se https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Exempel med automatisk avsökning:
Exempel med manuell avsökning:
Exempel med förloppsuppdateringar:
Exempel med ett föränderligt avsökningsintervall (standardvärdet är 15 sekunder):
Exempel med kopiering:
|
create |
Skapar en skrivskyddad ögonblicksbild av en blob. Se https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob |
delete(Blob |
Markerar den angivna bloben eller ögonblicksbilden för borttagning. Bloben tas senare bort under skräpinsamlingen. Observera att du måste ta bort alla ögonblicksbilder för att kunna ta bort en blob. Du kan ta bort båda samtidigt med åtgärden Ta bort blob. Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
delete |
Markerar den angivna bloben eller ögonblicksbilden för borttagning om den finns. Bloben tas senare bort under skräpinsamlingen. Observera att du måste ta bort alla ögonblicksbilder för att kunna ta bort en blob. Du kan ta bort båda samtidigt med åtgärden Ta bort blob. Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
delete |
Ta bort principen för immutablility på bloben. |
download(number, number, Blob |
Läser eller laddar ned en blob från systemet, inklusive dess metadata och egenskaper. Du kan också anropa Hämta blob för att läsa en ögonblicksbild.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob |
download |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure Blob parallellt med en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte tillhandahålls. Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar för Node.js/V8. Överväg att ladda nedToFile för blobar som är större än den här storleken. |
download |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure Blob parallellt med en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte tillhandahålls. Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar för Node.js/V8. Överväg att ladda nedToFile för blobar som är större än den här storleken. |
download |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure Blob till en lokal fil. Misslyckas om den angivna filsökvägen redan avslutas. Förskjutning och antal är valfria, skicka 0 respektive odefinierat för att ladda ned hela bloben. |
exists(Blob |
Returnerar true om Azure Blob-resursen som representeras av den här klienten finns. annars falskt. Obs! Använd den här funktionen med försiktighet eftersom en befintlig blob kan tas bort av andra klienter eller program. Tvärtom kan nya blobar läggas till av andra klienter eller program när den här funktionen har slutförts. |
generate |
Endast tillgängligt för BlobClient som skapats med en autentiseringsuppgift med delad nyckel. Genererar en SAS-URI (Blob Service Shared Access Signature) baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel. Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
get |
Skapar ett AppendBlobClient-objekt. |
get |
Hämta en BlobLeaseClient som hanterar lån på bloben. |
get |
Skapar ett BlockBlobClient-objekt. |
get |
Skapar ett PageBlobClient-objekt. |
get |
Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för bloben. Den returnerar inte innehållet i bloben. Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties VARNING! Objektet |
get |
Hämtar taggarna som är associerade med den underliggande bloben. |
set |
Anger nivån på en blob. Åtgärden tillåts på en sidblob i ett Premium Storage-konto och på en blockblob i ett bloblagringskonto (endast lokalt redundant lagring). En premium-sidblobs nivå avgör den tillåtna storleken, IOPS och bandbredden för bloben. En blockblobs nivå avgör lagringstypen Frekvent/Lågfrekvent/Arkivlagring. Den här åtgärden uppdaterar inte blobens ETag. Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier |
set |
Anger systemegenskaper för bloben. Om inget värde anges, eller inget värde som angetts för de angivna HTTP-huvudena för bloben, rensas dessa HTTP-blobhuvuden utan värde. Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
set |
Ange immutablility-princip på bloben. |
set |
Ange bevarande av juridiska skäl för bloben. |
set |
Anger användardefinierade metadata för den angivna bloben som ett eller flera namn/värde-par. Om inget alternativ har angetts eller inga metadata definierats i parametern tas blobmetadata bort. Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata |
set |
Anger taggar på den underliggande bloben. En blob kan ha upp till 10 taggar. Taggnycklarna måste vara mellan 1 och 128 tecken. Taggvärdena måste vara mellan 0 och 256 tecken. Giltiga taggnyckel- och värdetecken innehåller gemener och versaler, siffror (0–9), blanksteg (" ), plus ('+'), minus ('-'), punkt ('.'), snedstreck ('/'), kolon (':'), lika med ('=') och understreck ('_') . |
sync |
Den synkrona åtgärden Kopiera från URL kopierar en blob eller en Internetresurs till en ny blob. Det returnerar inte ett svar förrän kopian har slutförts. Se https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url |
undelete(Blob |
Återställer innehållet och metadata för mjuk borttagen blob och eventuella associerade mjukt borttagna ögonblicksbilder. Undelete Blob stöds endast i version 2017-07-29 eller senare. Se https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob |
with |
Skapar ett nytt BlobClient-objekt som pekar på en version av den här blobben. Ange "" tar bort versionId och returnerar en klient till basbloben. |
Konstruktorinformation
AppendBlobClient(string, PipelineLike)
Skapar en instans av AppendBlobClient. Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en tilläggsblob. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Om ett blobnamn innehåller ? eller %, blobnamnet måste vara kodat i URL:en.
new AppendBlobClient(url: string, pipeline: PipelineLike)
Parametrar
- url
-
string
En URL-sträng som pekar på Azure Storage-tilläggsblob, till exempel "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en blob. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Men om ett blobnamn innehåller ? eller %, blobnamnet måste vara kodat i URL:en. Till exempel en blob med namnet "my?blob%" ska URL:en vara "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
- pipeline
- PipelineLike
Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.
AppendBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Skapar en instans av AppendBlobClient. Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en tilläggsblob. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Om ett blobnamn innehåller ? eller %, blobnamnet måste vara kodat i URL:en.
new AppendBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parametrar
- url
-
string
En URL-sträng som pekar på Azure Storage-tilläggsblob, till exempel "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en blob. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Men om ett blobnamn innehåller ? eller %, blobnamnet måste vara kodat i URL:en. Till exempel en blob med namnet "my?blob%" ska URL:en vara "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity
begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.
- options
- StoragePipelineOptions
Valfritt. Alternativ för att konfigurera HTTP-pipelinen.
AppendBlobClient(string, string, string, StoragePipelineOptions)
Skapar en instans av AppendBlobClient.
new AppendBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
Parametrar
- connectionString
-
string
Kontoanslutningssträng eller en SAS-anslutningssträng för ett Azure Storage-konto.
[ Obs! Kontoanslutningssträngen kan bara användas i NODE.JS körning. ] Exempel på kontoanslutningssträng –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
EXEMPEL på SAS-anslutningssträng – 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
Containernamn.
- blobName
-
string
Blobnamn.
- options
- StoragePipelineOptions
Valfritt. Alternativ för att konfigurera HTTP-pipelinen.
Egenskapsinformation
containerName
Namnet på lagringscontainern som bloben är associerad med.
string containerName
Egenskapsvärde
string
name
Namnet på bloben.
string name
Egenskapsvärde
string
Information om ärvda egenskaper
accountName
credential
Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity
begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Egenskapsvärde
Ärvd frånBlobClient.credential
url
Metodinformation
appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)
Genomför ett nytt datablock i slutet av den befintliga tilläggsbloben.
Se https://docs.microsoft.com/rest/api/storageservices/append-block
function appendBlock(body: HttpRequestBody, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>
Parametrar
- body
- HttpRequestBody
Data som ska läggas till.
- contentLength
-
number
Längden på brödtexten i byte.
- options
- AppendBlobAppendBlockOptions
Alternativ för åtgärden Lägg till block.
Exempel på användning:
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);
Returer
Promise<AppendBlobAppendBlockResponse>
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)
Åtgärden Lägg till block checkar in ett nytt datablock i slutet av en befintlig tilläggsblob där innehållet läse från en käll-URL.
Se 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>
Parametrar
- sourceURL
-
string
URL:en till bloben som ska vara källan till kopian. En källblob i samma lagringskonto kan autentiseras via delad nyckel. Men om källan är en blob i ett annat konto måste källbloben antingen vara offentlig eller autentiseras via en signatur för delad åtkomst. Om källbloben är offentlig krävs ingen autentisering för att utföra åtgärden.
- sourceOffset
-
number
Förskjutning i källa som ska läggas till
- count
-
number
Antal byte som ska läggas till som ett block
Returer
Promise<AppendBlobAppendBlockFromUrlResponse>
create(AppendBlobCreateOptions)
Skapar en tilläggsblob med 0 längder. Anropa AppendBlock för att lägga till data i en tilläggsblob.
Se https://docs.microsoft.com/rest/api/storageservices/put-blob
function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>
Parametrar
- options
- AppendBlobCreateOptions
Alternativ för åtgärden Lägg till block skapa.
Exempel på användning:
const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();
Returer
Promise<AppendBlobCreateResponse>
createIfNotExists(AppendBlobCreateIfNotExistsOptions)
Skapar en tilläggsblob med 0 längder. Anropa AppendBlock för att lägga till data i en tilläggsblob. Om bloben med samma namn redan finns förblir innehållet i den befintliga bloben oförändrat.
Se https://docs.microsoft.com/rest/api/storageservices/put-blob
function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>
Parametrar
Returer
Promise<AppendBlobCreateIfNotExistsResponse>
seal(AppendBlobSealOptions)
Förseglar tilläggsbloben, vilket gör den skrivskyddad.
function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>
Parametrar
- options
- AppendBlobSealOptions
Returer
Promise<AppendBlobAppendBlockResponse>
withSnapshot(string)
Skapar ett nytt AppendBlobClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilder. Ange "" tar bort ögonblicksbilden och returnerar en klient till basbloben.
function withSnapshot(snapshot: string): AppendBlobClient
Parametrar
- snapshot
-
string
Tidsstämpeln för ögonblicksbilden.
Returer
Ett nytt AppendBlobClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilder.
Ärvd metodinformation
abortCopyFromURL(string, BlobAbortCopyFromURLOptions)
Avbryter en väntande asynkron kopieringsblobåtgärd och lämnar en målblob med noll längd och fullständiga metadata. Version 2012-02-12 och senare.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>
Parametrar
- copyId
-
string
ID för åtgärden Kopiera från URL.
- options
- BlobAbortCopyFromURLOptions
Valfria alternativ för åtgärden Avbruten blobkopiering från URL.
Returer
Promise<BlobAbortCopyFromURLResponse>
Ärvd frånBlobClient.abortCopyFromURL
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)
Kopierar asynkront en blob till ett mål i lagringskontot.
Den här metoden returnerar en tidskrävande åtgärdsmätning som gör att du kan vänta på obestämd tid tills kopieringen har slutförts.
Du kan också avbryta en kopia innan den är klar genom att anropa cancelOperation
i polleraren.
Observera att återanropet onProgress inte anropas om åtgärden slutförs i den första begäran, och om du försöker avbryta en slutförd kopia utlöses ett fel.
I version 2012-02-12 och senare kan källan för en kopieringsblobåtgärd vara en checkad blob i alla Azure Storage-konton. Från och med version 2015-02-21 kan källan för en kopieringsblobåtgärd vara en Azure-fil i valfritt Azure-lagringskonto. Endast lagringskonton som skapats den 7 juni 2012 eller senare tillåter kopieringsblobåtgärden att kopiera från ett annat lagringskonto.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob
Exempel med automatisk avsökning:
const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();
Exempel med manuell avsökning:
const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
await poller.poll();
}
const result = copyPoller.getResult();
Exempel med förloppsuppdateringar:
const copyPoller = await blobClient.beginCopyFromURL('url', {
onProgress(state) {
console.log(`Progress: ${state.copyProgress}`);
}
});
const result = await copyPoller.pollUntilDone();
Exempel med ett föränderligt avsökningsintervall (standardvärdet är 15 sekunder):
const copyPoller = await blobClient.beginCopyFromURL('url', {
intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();
Exempel med kopiering:
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>>
Parametrar
- copySource
-
string
url till källan Azure Blob/File.
- options
- BlobBeginCopyFromURLOptions
Valfria alternativ för åtgärden Starta blobkopiering från URL.
Returer
Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
Ärvd frånBlobClient.beginCopyFromURL
createSnapshot(BlobCreateSnapshotOptions)
Skapar en skrivskyddad ögonblicksbild av en blob.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>
Parametrar
- options
- BlobCreateSnapshotOptions
Valfria alternativ för åtgärden Skapa ögonblicksbild av blobb.
Returer
Promise<BlobCreateSnapshotResponse>
Ärvd frånBlobClient.createSnapshot
delete(BlobDeleteOptions)
Markerar den angivna bloben eller ögonblicksbilden för borttagning. Bloben tas senare bort under skräpinsamlingen. Observera att du måste ta bort alla ögonblicksbilder för att kunna ta bort en blob. Du kan ta bort båda samtidigt med åtgärden Ta bort blob.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>
Parametrar
- options
- BlobDeleteOptions
Valfria alternativ för blobborttagning.
Returer
Promise<BlobDeleteResponse>
Ärvd frånBlobClient.delete
deleteIfExists(BlobDeleteOptions)
Markerar den angivna bloben eller ögonblicksbilden för borttagning om den finns. Bloben tas senare bort under skräpinsamlingen. Observera att du måste ta bort alla ögonblicksbilder för att kunna ta bort en blob. Du kan ta bort båda samtidigt med åtgärden Ta bort blob.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>
Parametrar
- options
- BlobDeleteOptions
Valfria alternativ för blobborttagning.
Returer
Promise<BlobDeleteIfExistsResponse>
Ärvd frånBlobClient.deleteIfExists
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Ta bort principen för immutablility på bloben.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>
Parametrar
Valfria alternativ för att ta bort principen för oföränderlighet på bloben.
Returer
Promise<BlobDeleteImmutabilityPolicyResponse>
Ärvd frånBlobClient.deleteImmutabilityPolicy
download(number, number, BlobDownloadOptions)
Läser eller laddar ned en blob från systemet, inklusive dess metadata och egenskaper. Du kan också anropa Hämta blob för att läsa en ögonblicksbild.
- I Node.js returnerar data i en läsbar dataström readableStreamBody
- I webbläsare returnerar data i en promise blobBody
Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
Parametrar
- offset
-
number
Från vilken position bloben ska laddas ned, större än eller lika med 0
- count
-
number
Hur mycket data som ska laddas ned, större än 0. Laddas ned till slutet när det är odefinierat
- options
- BlobDownloadOptions
Valfria alternativ för blobnedladdning.
Exempel på användning (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);
});
}
Exempel på användning (webbläsare):
// 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);
});
}
Returer
Promise<BlobDownloadResponseParsed>
Ärvd frånBlobClient.download
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.
Laddar ned en Azure Blob parallellt med en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte tillhandahålls.
Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar för Node.js/V8. Överväg att ladda nedToFile för blobar som är större än den här storleken.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Parametrar
- buffer
-
Buffer
Buffert som ska fyllas, måste ha en längd som är större än antalet
- offset
-
number
Från vilken position blockbloben ska laddas ned (i byte)
- count
-
number
Hur mycket data (i byte) som ska laddas ned. Laddas ned till slutet när odefinierade skickas
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Returer
Promise<Buffer>
Ärvd frånBlobClient.downloadToBuffer
downloadToBuffer(number, number, BlobDownloadToBufferOptions)
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.
Laddar ned en Azure Blob parallellt med en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte tillhandahålls.
Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar för Node.js/V8. Överväg att ladda nedToFile för blobar som är större än den här storleken.
function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Parametrar
- offset
-
number
Från vilken position blockbloben ska laddas ned (i byte)
- count
-
number
Hur mycket data (i byte) som ska laddas ned. Laddas ned till slutet när odefinierade skickas
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Returer
Promise<Buffer>
Ärvd frånBlobClient.downloadToBuffer
downloadToFile(string, number, number, BlobDownloadOptions)
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.
Laddar ned en Azure Blob till en lokal fil. Misslyckas om den angivna filsökvägen redan avslutas. Förskjutning och antal är valfria, skicka 0 respektive odefinierat för att ladda ned hela bloben.
function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
Parametrar
- filePath
-
string
- offset
-
number
Från vilken position blockbloben ska laddas ned.
- count
-
number
Hur mycket data som ska laddas ned. Laddas ned till slutet när odefinierade skickas.
- options
- BlobDownloadOptions
Alternativ för alternativ för blobnedladdning.
Returer
Promise<BlobDownloadResponseParsed>
Svarsdata för blobnedladdning, men med readableStreamBody inställt på odefinierat eftersom dess innehåll redan har lästs och skrivits till en lokal fil på den angivna sökvägen.
Ärvd frånBlobClient.downloadToFile
exists(BlobExistsOptions)
Returnerar true om Azure Blob-resursen som representeras av den här klienten finns. annars falskt.
Obs! Använd den här funktionen med försiktighet eftersom en befintlig blob kan tas bort av andra klienter eller program. Tvärtom kan nya blobar läggas till av andra klienter eller program när den här funktionen har slutförts.
function exists(options?: BlobExistsOptions): Promise<boolean>
Parametrar
- options
- BlobExistsOptions
alternativ för åtgärden Finns.
Returer
Promise<boolean>
Ärvd frånBlobClient.exists
generateSasUrl(BlobGenerateSasUrlOptions)
Endast tillgängligt för BlobClient som skapats med en autentiseringsuppgift med delad nyckel.
Genererar en SAS-URI (Blob Service Shared Access Signature) baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>
Parametrar
- options
- BlobGenerateSasUrlOptions
Valfria parametrar.
Returer
Promise<string>
SAS-URI:n som består av URI:n för den resurs som representeras av den här klienten, följt av den genererade SAS-token.
Ärvd frånBlobClient.generateSasUrl
getAppendBlobClient()
Skapar ett AppendBlobClient-objekt.
function getAppendBlobClient(): AppendBlobClient
Returer
Ärvd frånBlobClient.getAppendBlobClient
getBlobLeaseClient(string)
Hämta en BlobLeaseClient som hanterar lån på bloben.
function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient
Parametrar
- proposeLeaseId
-
string
Ursprungligt föreslaget låne-ID.
Returer
Ett nytt BlobLeaseClient-objekt för att hantera lån på bloben.
Ärvd frånBlobClient.getBlobLeaseClient
getBlockBlobClient()
Skapar ett BlockBlobClient-objekt.
function getBlockBlobClient(): BlockBlobClient
Returer
Ärvd frånBlobClient.getBlockBlobClient
getPageBlobClient()
Skapar ett PageBlobClient-objekt.
function getPageBlobClient(): PageBlobClient
Returer
Ärvd frånBlobClient.getPageBlobClient
getProperties(BlobGetPropertiesOptions)
Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för bloben. Den returnerar inte innehållet i bloben.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
VARNING! Objektet metadata
som returneras i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av metoderna i ContainerClient som listar blobar med hjälp av includeMetadata
alternativet, vilket behåller deras ursprungliga hölje.
function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>
Parametrar
- options
- BlobGetPropertiesOptions
Valfria alternativ för att hämta egenskaper.
Returer
Promise<BlobGetPropertiesResponse>
Ärvd frånBlobClient.getProperties
getTags(BlobGetTagsOptions)
Hämtar taggarna som är associerade med den underliggande bloben.
function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>
Parametrar
- options
- BlobGetTagsOptions
Returer
Promise<BlobGetTagsResponse>
Ärvd frånBlobClient.getTags
setAccessTier(string, BlobSetTierOptions)
Anger nivån på en blob. Åtgärden tillåts på en sidblob i ett Premium Storage-konto och på en blockblob i ett bloblagringskonto (endast lokalt redundant lagring). En premium-sidblobs nivå avgör den tillåtna storleken, IOPS och bandbredden för bloben. En blockblobs nivå avgör lagringstypen Frekvent/Lågfrekvent/Arkivlagring. Den här åtgärden uppdaterar inte blobens ETag.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>
Parametrar
- tier
-
string
Den nivå som ska anges på bloben. Giltiga värden är Frekvent, Lågfrekvent eller Arkiv.
- options
- BlobSetTierOptions
Valfria alternativ för åtgärden blobuppsättningsnivå.
Returer
Promise<BlobSetTierResponse>
Ärvd frånBlobClient.setAccessTier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)
Anger systemegenskaper för bloben.
Om inget värde anges, eller inget värde som angetts för de angivna HTTP-huvudena för bloben, rensas dessa HTTP-blobhuvuden utan värde.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>
Parametrar
- blobHTTPHeaders
- BlobHTTPHeaders
Om inget värde anges, eller inget värde som angetts för de angivna HTTP-huvudena för bloben, rensas dessa HTTP-blobhuvuden utan värde.
Ett vanligt sidhuvud att ange är blobContentType
att göra det möjligt för webbläsaren att tillhandahålla funktioner baserat på filtyp.
- options
- BlobSetHTTPHeadersOptions
Valfria alternativ för åtgärden Blob Set HTTP Headers (Http-huvuden).
Returer
Promise<BlobSetHTTPHeadersResponse>
Ärvd frånBlobClient.setHTTPHeaders
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Ange immutablility-princip på bloben.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>
Parametrar
- immutabilityPolicy
- BlobImmutabilityPolicy
- options
- BlobSetImmutabilityPolicyOptions
Valfria alternativ för att ange en oföränderlighetsprincip för bloben.
Returer
Promise<BlobSetImmutabilityPolicyResponse>
Ärvd frånBlobClient.setImmutabilityPolicy
setLegalHold(boolean, BlobSetLegalHoldOptions)
Ange bevarande av juridiska skäl för bloben.
function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>
Parametrar
- legalHoldEnabled
-
boolean
- options
- BlobSetLegalHoldOptions
Valfria alternativ för att ange bevarande av juridiska skäl för bloben.
Returer
Promise<BlobSetLegalHoldResponse>
Ärvd frånBlobClient.setLegalHold
setMetadata(Metadata, BlobSetMetadataOptions)
Anger användardefinierade metadata för den angivna bloben som ett eller flera namn/värde-par.
Om inget alternativ har angetts eller inga metadata definierats i parametern tas blobmetadata bort.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>
Parametrar
- metadata
- Metadata
Ersätt befintliga metadata med det här värdet. Om inget värde anges tas befintliga metadata bort.
- options
- BlobSetMetadataOptions
Valfria alternativ för att ange metadataåtgärd.
Returer
Promise<BlobSetMetadataResponse>
Ärvd frånBlobClient.setMetadata
setTags(Tags, BlobSetTagsOptions)
Anger taggar på den underliggande bloben. En blob kan ha upp till 10 taggar. Taggnycklarna måste vara mellan 1 och 128 tecken. Taggvärdena måste vara mellan 0 och 256 tecken. Giltiga taggnyckel- och värdetecken innehåller gemener och versaler, siffror (0–9), blanksteg (" ), plus ('+'), minus ('-'), punkt ('.'), snedstreck ('/'), kolon (':'), lika med ('=') och understreck ('_') .
function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>
Parametrar
- tags
- Tags
- options
- BlobSetTagsOptions
Returer
Promise<BlobSetTagsResponse>
Ärvd frånBlobClient.setTags
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)
Den synkrona åtgärden Kopiera från URL kopierar en blob eller en Internetresurs till en ny blob. Det returnerar inte ett svar förrän kopian har slutförts.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>
Parametrar
- copySource
-
string
Käll-URL:en att kopiera från, Signatur för delad åtkomst (SAS) kanske behövs för autentisering
- options
- BlobSyncCopyFromURLOptions
Returer
Promise<BlobCopyFromURLResponse>
Ärvd frånBlobClient.syncCopyFromURL
undelete(BlobUndeleteOptions)
Återställer innehållet och metadata för mjuk borttagen blob och eventuella associerade mjukt borttagna ögonblicksbilder. Undelete Blob stöds endast i version 2017-07-29 eller senare.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>
Parametrar
- options
- BlobUndeleteOptions
Valfria alternativ för åtgärden Blob Undelete.
Returer
Promise<BlobUndeleteResponse>
Ärvd frånBlobClient.undelete
withVersion(string)
Skapar ett nytt BlobClient-objekt som pekar på en version av den här blobben. Ange "" tar bort versionId och returnerar en klient till basbloben.
function withVersion(versionId: string): BlobClient
Parametrar
- versionId
-
string
VersionId.
Returer
Ett nytt BlobClient-objekt som pekar på blobens version.
Ärvd frånBlobClient.withVersion