PageBlobClient class
PageBlobClient definieert een set bewerkingen die van toepassing zijn op pagina-blobs.
- Uitbreiding
Constructors
Page |
Hiermee maakt u een exemplaar van PageBlobClient. |
Page |
Hiermee maakt u een exemplaar van PageBlobClient. 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 ? of %, moet de blobnaam zijn gecodeerd in de URL. |
Page |
Hiermee maakt u een exemplaar van PageBlobClient. |
Eigenschappen
container |
De naam van de opslagcontainer waar de blob aan is gekoppeld. |
name | De naam van de blob. |
Overgenomen eigenschappen
account |
|
credential | Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het |
url | Gecodeerde URL-tekenreekswaarde. |
Methoden
clear |
Hiermee worden de opgegeven pagina's van de pagina-blob vrijgemaakt. Zie https://docs.microsoft.com/rest/api/storageservices/put-page |
create(number, Page |
Hiermee maakt u een pagina-blob met de opgegeven lengte. Roep uploadPages aan om gegevensgegevens te uploaden naar een pagina-blob. Zie https://docs.microsoft.com/rest/api/storageservices/put-blob |
create |
Hiermee maakt u een pagina-blob met de opgegeven lengte. Roep uploadPages aan om gegevensgegevens te uploaden naar een pagina-blob. Als de blob met dezelfde naam al bestaat, blijft de inhoud van de bestaande blob ongewijzigd. Zie https://docs.microsoft.com/rest/api/storageservices/put-blob |
get |
Retourneert de lijst met geldige paginabereiken voor een pagina-blob of momentopname van een pagina-blob. Zie https://docs.microsoft.com/rest/api/storageservices/get-page-ranges |
get |
Hiermee haalt u de verzameling paginabereiken op die verschillen tussen een opgegeven momentopname en deze pagina-blob. Zie https://docs.microsoft.com/rest/api/storageservices/get-page-ranges |
get |
Hiermee haalt u de verzameling paginabereiken op die verschillen tussen een opgegeven momentopname en deze pagina-blob voor beheerde schijven. Zie https://docs.microsoft.com/rest/api/storageservices/get-page-ranges |
list |
Retourneert een asynchrone iterator naar een lijst met paginabereiken voor een pagina-blob. Zie https://docs.microsoft.com/rest/api/storageservices/get-page-ranges .byPage() retourneert een asynchrone iterator naar een lijst met paginabereiken voor een pagina-blob. Voorbeeld met syntaxis
Voorbeeld met
Voorbeeld met
Voorbeeld van paging met een markering:
|
list |
Retourneert een asynchrone iterator naar een lijst met paginabereiken die verschillen tussen een opgegeven momentopname en deze pagina-blob. Zie https://docs.microsoft.com/rest/api/storageservices/get-page-ranges .byPage() retourneert een asynchrone iterator naar een lijst met paginabereiken die verschillen tussen een opgegeven momentopname en deze pagina-blob. Voorbeeld met syntaxis
Voorbeeld met
Voorbeeld met
Voorbeeld van paging met een markering:
|
resize(number, Page |
Hiermee wijzigt u de grootte van de pagina-blob in de opgegeven grootte (dit moet een veelvoud van 512 zijn). Zie https://docs.microsoft.com/rest/api/storageservices/set-blob-properties |
start |
Hiermee start u een bewerking om een incrementele kopie van de momentopname van een pagina-blob naar deze pagina-blob te starten. De momentopname wordt zodanig gekopieerd dat alleen de differentiële wijzigingen tussen de eerder gekopieerde momentopname worden overgebracht naar de bestemming. De gekopieerde momentopnamen zijn volledige kopieën van de oorspronkelijke momentopname en kunnen zoals gewoonlijk worden gelezen of gekopieerd. Zie https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots |
update |
Hiermee stelt u het volgnummer van een pagina-blob in. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
upload |
Hiermee worden 1 of meer pagina's naar de pagina-blob geschreven. De begin- en eindverschuivingen moeten een veelvoud van 512 zijn. Zie https://docs.microsoft.com/rest/api/storageservices/put-page |
upload |
Met de bewerking Pagina's uploaden wordt een reeks pagina's naar een pagina-blob geschreven waar de inhoud wordt gelezen vanuit een URL. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url |
with |
Hiermee maakt u een nieuw PageBlobClient-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. |
Overgenomen 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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob |
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 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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Voorbeeld van automatische polling:
Voorbeeld van handmatige polling:
Voorbeeld van het gebruik van voortgangsupdates:
Voorbeeld met een wijzigend polling-interval (standaard 15 seconden):
Voorbeeld van het opzeggen van kopie:
|
create |
Hiermee maakt u een alleen-lezen momentopname van een blob. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob |
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 downloadToFile overwegen. |
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 downloadToFile overwegen. |
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. Verschuiving en aantal zijn optioneel, geef respectievelijk 0 en niet-gedefinieerd 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 wordt verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe blobs worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid. |
generate |
Alleen beschikbaar voor BlobClient die is gemaakt met een gedeelde sleutelreferentie. Genereert een SAS-URI (Shared Access Signature) voor Blob Service op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
get |
Hiermee maakt u een AppendBlobClient-object. |
get |
Haal een 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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties WAARSCHUWING: het |
get |
Hiermee haalt u de tags op die zijn gekoppeld aan de onderliggende blob. |
set |
Hiermee stelt u de laag voor 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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier |
set |
Hiermee stelt u systeemeigenschappen voor de blob in. 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 waarde gewist. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
set |
Stel beleid voor onveranderbaarheid 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 blobmetagegevens verwijderd. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata |
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 Copy From URL kopieert u een blob of een internetbron naar een nieuwe blob. Er wordt pas een antwoord geretourneerd als het kopiëren is voltooid. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url |
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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob |
with |
Hiermee maakt u een nieuw BlobClient-object dat verwijst naar een versie van deze blob. Als u opgeeft, wordt de versionId verwijderd en wordt een client geretourneerd naar de basis-blob. |
Constructordetails
PageBlobClient(string, PipelineLike)
Hiermee maakt u een exemplaar van PageBlobClient.
new PageBlobClient(url: string, pipeline: PipelineLike)
Parameters
- url
-
string
Een URL-tekenreeks die verwijst naar azure Storage-pagina-blob, zoals 'https://myaccount.blob.core.windows.net/mycontainer/pageblob". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.blob.core.windows.net/mycontainer/pageblob?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.
PageBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Hiermee maakt u een exemplaar van PageBlobClient. 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 ? of %, moet de blobnaam zijn gecodeerd in de URL.
new PageBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parameters
- url
-
string
Een clienttekenreeks die verwijst naar de pagina-blob van Azure Storage, zoals 'https://myaccount.blob.core.windows.net/mycontainer/pageblob". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString".
- 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.
PageBlobClient(string, string, string, StoragePipelineOptions)
Hiermee maakt u een exemplaar van PageBlobClient.
new PageBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
Parameters
- connectionString
-
string
Verbindingsreeks voor het account of een SAS-verbindingsreeks van een Azure-opslagaccount.
[ Opmerking: de verbindingsreeks van het account kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van accountverbindingsreeks -
DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
Voorbeeld van SAS-verbindingsreeks - 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
containerName
De naam van de opslagcontainer waar de blob aan is gekoppeld.
string containerName
Waarde van eigenschap
string
name
De naam van de blob.
string name
Waarde van eigenschap
string
Details van overgenomen eigenschap
accountName
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 TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Waarde van eigenschap
Overgenomen vanBlobClient.credential
url
Gecodeerde URL-tekenreekswaarde.
url: string
Waarde van eigenschap
string
Overgenomen vanBlobClient.url
Methodedetails
clearPages(number, number, PageBlobClearPagesOptions)
Hiermee worden de opgegeven pagina's van de pagina-blob vrijgemaakt.
Zie https://docs.microsoft.com/rest/api/storageservices/put-page
function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>
Parameters
- offset
-
number
Begin van de bytepositie van de pagina's om te wissen.
- count
-
number
Aantal bytes dat moet worden gewist.
- options
- PageBlobClearPagesOptions
Opties voor de bewerking Pagina-blob pagina's wissen.
Retouren
Promise<PageBlobClearPagesResponse>
Antwoordgegevens voor de pagina-blob-bewerking Pagina's wissen.
create(number, PageBlobCreateOptions)
Hiermee maakt u een pagina-blob met de opgegeven lengte. Roep uploadPages aan om gegevensgegevens te uploaden naar een pagina-blob.
Zie https://docs.microsoft.com/rest/api/storageservices/put-blob
function create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>
Parameters
- size
-
number
grootte van de pagina-blob.
- options
- PageBlobCreateOptions
Opties voor de bewerking Pagina-blob maken.
Retouren
Promise<PageBlobCreateResponse>
Antwoordgegevens voor de bewerking Pagina-blob maken.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)
Hiermee maakt u een pagina-blob met de opgegeven lengte. Roep uploadPages aan om gegevensgegevens te uploaden naar een pagina-blob. Als de blob met dezelfde naam al bestaat, blijft de inhoud van de bestaande blob ongewijzigd.
Zie https://docs.microsoft.com/rest/api/storageservices/put-blob
function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions): Promise<PageBlobCreateIfNotExistsResponse>
Parameters
- size
-
number
grootte van de pagina-blob.
- options
- PageBlobCreateIfNotExistsOptions
Retouren
Promise<PageBlobCreateIfNotExistsResponse>
getPageRanges(number, number, PageBlobGetPageRangesOptions)
Retourneert de lijst met geldige paginabereiken voor een pagina-blob of momentopname van een pagina-blob.
Zie https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>
Parameters
- offset
-
number
De bytepositie van de paginabereiken starten.
- count
-
number
Aantal op te halen bytes.
- options
- PageBlobGetPageRangesOptions
Opties voor de bewerking Bereiken voor pagina-blob ophalen.
Retouren
Promise<PageBlobGetPageRangesResponse>
Antwoordgegevens voor de bewerking Bereiken voor pagina-blob ophalen.
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)
Hiermee haalt u de verzameling paginabereiken op die verschillen tussen een opgegeven momentopname en deze pagina-blob.
Zie https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>
Parameters
- offset
-
number
Bytepositie van de pagina-blob starten
- count
-
number
Aantal bytes om bereiken op te halen, diff.
- prevSnapshot
-
string
Tijdstempel van momentopname om het verschil op te halen.
- options
- PageBlobGetPageRangesDiffOptions
Opties voor de bewerking Pagina-blob paginabereiken ophalen.
Retouren
Promise<PageBlobGetPageRangesDiffResponse>
Antwoordgegevens voor de bewerking Page Blob Get Page Range Diff.
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)
Hiermee haalt u de verzameling paginabereiken op die verschillen tussen een opgegeven momentopname en deze pagina-blob voor beheerde schijven.
Zie https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>
Parameters
- offset
-
number
Bytepositie van de pagina-blob starten
- count
-
number
Aantal bytes om bereiken op te halen, diff.
- prevSnapshotUrl
-
string
URL van momentopname om het verschil op te halen.
- options
- PageBlobGetPageRangesDiffOptions
Opties voor de bewerking Pagina-blob paginabereiken ophalen.
Retouren
Promise<PageBlobGetPageRangesDiffResponse>
Antwoordgegevens voor de bewerking Page Blob Get Page Range Diff.
listPageRanges(number, number, PageBlobListPageRangesOptions)
Retourneert een asynchrone iterator naar een lijst met paginabereiken voor een pagina-blob.
Zie https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
.byPage() retourneert een asynchrone iterator naar een lijst met paginabereiken voor een pagina-blob.
Voorbeeld met syntaxis for await
:
// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
Voorbeeld met iter.next()
:
let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
pageRangeItem = await iter.next();
}
Voorbeeld met byPage()
:
// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
for (const pageRange of response) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
}
Voorbeeld van paging met een markering:
let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 page ranges
for (const pageRange of response) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 page ranges
for (const blob of response) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
function listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>
Parameters
- offset
-
number
De bytepositie van de paginabereiken starten.
- count
-
number
Aantal op te halen bytes.
- options
- PageBlobListPageRangesOptions
Opties voor de bewerking Bereiken voor pagina-blob ophalen.
Retouren
Een asynchroneIterableIterator die ondersteuning biedt voor paging.
listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)
Retourneert een asynchrone iterator naar een lijst met paginabereiken die verschillen tussen een opgegeven momentopname en deze pagina-blob.
Zie https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
.byPage() retourneert een asynchrone iterator naar een lijst met paginabereiken die verschillen tussen een opgegeven momentopname en deze pagina-blob.
Voorbeeld met syntaxis for await
:
// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
Voorbeeld met iter.next()
:
let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
pageRangeItem = await iter.next();
}
Voorbeeld met byPage()
:
// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
for (const pageRange of response) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
}
Voorbeeld van paging met een markering:
let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 page ranges
for (const pageRange of response) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 page ranges
for (const blob of response) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
function listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>
Parameters
- offset
-
number
De bytepositie van de paginabereiken starten.
- count
-
number
Aantal op te halen bytes.
- prevSnapshot
-
string
Tijdstempel van momentopname om het verschil op te halen.
Opties voor de bewerking Bereiken voor pagina-blob ophalen.
Retouren
Een asynchroneIterableIterator die ondersteuning biedt voor paging.
resize(number, PageBlobResizeOptions)
Hiermee wijzigt u de grootte van de pagina-blob in de opgegeven grootte (dit moet een veelvoud van 512 zijn).
Zie https://docs.microsoft.com/rest/api/storageservices/set-blob-properties
function resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>
Parameters
- size
-
number
Doelgrootte
- options
- PageBlobResizeOptions
Opties voor de bewerking Formaat van paginablob wijzigen.
Retouren
Promise<PageBlobResizeResponse>
Antwoordgegevens voor de bewerking Formaat van paginablob wijzigen.
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)
Hiermee start u een bewerking om een incrementele kopie van de momentopname van een pagina-blob naar deze pagina-blob te starten. De momentopname wordt zodanig gekopieerd dat alleen de differentiële wijzigingen tussen de eerder gekopieerde momentopname worden overgebracht naar de bestemming. De gekopieerde momentopnamen zijn volledige kopieën van de oorspronkelijke momentopname en kunnen zoals gewoonlijk worden gelezen of gekopieerd.
Zie https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions): Promise<PageBlobCopyIncrementalResponse>
Parameters
- copySource
-
string
Hiermee geeft u de naam van de blobmomentopname van de bronpagina op. Bijvoorbeeld: https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
Opties voor de incrementele bewerking Pagina-blob kopiëren.
Retouren
Promise<PageBlobCopyIncrementalResponse>
Antwoordgegevens voor de incrementele bewerking pagina-blobkopie.
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)
Hiermee stelt u het volgnummer van een pagina-blob in.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions): Promise<PageBlobUpdateSequenceNumberResponse>
Parameters
- sequenceNumberAction
- SequenceNumberActionType
Geeft aan hoe de service het volgnummer van de blob moet wijzigen.
- sequenceNumber
-
number
Vereist als sequenceNumberAction max of update is
Opties voor de bewerking Reeksnummer pagina-blob bijwerken.
Retouren
Promise<PageBlobUpdateSequenceNumberResponse>
Antwoordgegevens voor de bewerking Reeksnummer pagina-blob bijwerken.
uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)
Hiermee worden 1 of meer pagina's naar de pagina-blob geschreven. De begin- en eindverschuivingen moeten een veelvoud van 512 zijn.
Zie https://docs.microsoft.com/rest/api/storageservices/put-page
function uploadPages(body: RequestBodyType, offset: number, count: number, options?: PageBlobUploadPagesOptions): Promise<PageBlobUploadPagesResponse>
Parameters
- body
- HttpRequestBody
Te uploaden gegevens
- offset
-
number
Verschuiving van doelpagina-blob
- count
-
number
Inhoudslengte van de hoofdtekst, ook aantal bytes dat moet worden geüpload
- options
- PageBlobUploadPagesOptions
Opties voor de bewerking Pagina-blob-uploadpagina's.
Retouren
Promise<PageBlobUploadPagesResponse>
Antwoordgegevens voor de bewerking Pagina's uploaden in blob.
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)
Met de bewerking Pagina's uploaden wordt een reeks pagina's naar een pagina-blob geschreven waar de inhoud wordt gelezen vanuit een URL.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>
Parameters
- sourceURL
-
string
Geef een URL op naar de kopieerbron, sas (Shared Access Signature) die mogelijk nodig is voor verificatie
- sourceOffset
-
number
De bronverschuiving waaruit u wilt kopiëren. Geef 0 door om te kopiëren vanaf het begin van de blob van de bronpagina
- destOffset
-
number
Verschuiving van doelpagina-blob
- count
-
number
Aantal bytes dat moet worden geüpload vanaf de blob van de bronpagina
Retouren
Promise<PageBlobUploadPagesFromURLResponse>
withSnapshot(string)
Hiermee maakt u een nieuw PageBlobClient-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): PageBlobClient
Parameters
- snapshot
-
string
Het tijdstempel van de momentopname.
Retouren
Een nieuw PageBlobClient-object dat identiek is aan de bron, maar met het opgegeven tijdstempel van de momentopname.
Details overgenomen methode
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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>
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>
Overgenomen vanBlobClient.abortCopyFromURL
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 van 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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob
Voorbeeld van automatische polling:
const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();
Voorbeeld van handmatige polling:
const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
await poller.poll();
}
const result = copyPoller.getResult();
Voorbeeld van het gebruik van voortgangsupdates:
const copyPoller = await blobClient.beginCopyFromURL('url', {
onProgress(state) {
console.log(`Progress: ${state.copyProgress}`);
}
});
const result = await copyPoller.pollUntilDone();
Voorbeeld met een wijzigend polling-interval (standaard 15 seconden):
const copyPoller = await blobClient.beginCopyFromURL('url', {
intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();
Voorbeeld van het opzeggen van kopie:
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>>
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<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
Overgenomen vanBlobClient.beginCopyFromURL
createSnapshot(BlobCreateSnapshotOptions)
Hiermee maakt u een alleen-lezen momentopname van een blob.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>
Parameters
- options
- BlobCreateSnapshotOptions
Optionele opties voor de bewerking Blob-momentopname maken.
Retouren
Promise<BlobCreateSnapshotResponse>
Overgenomen vanBlobClient.createSnapshot
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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>
Parameters
- options
- BlobDeleteOptions
Optionele opties voor de bewerking Blob verwijderen.
Retouren
Promise<BlobDeleteResponse>
Overgenomen vanBlobClient.delete
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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>
Parameters
- options
- BlobDeleteOptions
Optionele opties voor de bewerking Blob verwijderen.
Retouren
Promise<BlobDeleteIfExistsResponse>
Overgenomen vanBlobClient.deleteIfExists
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Verwijder het beleid immutablility op de blob.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>
Parameters
Optionele opties voor het verwijderen van beleid voor onveranderbaarheid op de blob.
Retouren
Promise<BlobDeleteImmutabilityPolicyResponse>
Overgenomen vanBlobClient.deleteImmutabilityPolicy
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
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
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>
Overgenomen vanBlobClient.download
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 downloadToFile overwegen.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
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 gedownload tot het einde bij het doorgeven van niet-gedefinieerde
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Retouren
Promise<Buffer>
Overgenomen vanBlobClient.downloadToBuffer
downloadToBuffer(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 downloadToFile overwegen.
function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
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 bij het doorgeven van niet-gedefinieerde
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Retouren
Promise<Buffer>
Overgenomen vanBlobClient.downloadToBuffer
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. Verschuiving en aantal zijn optioneel, geef respectievelijk 0 en niet-gedefinieerd door om de hele blob te downloaden.
function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
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 niet-gedefinieerd wordt doorgegeven.
- options
- BlobDownloadOptions
Opties voor blobdownloadopties.
Retouren
Promise<BlobDownloadResponseParsed>
De antwoordgegevens voor de blob-downloadbewerking, maar met readableStreamBody ingesteld op undefined omdat de inhoud al is gelezen en geschreven in een lokaal bestand op het opgegeven pad.
Overgenomen vanBlobClient.downloadToFile
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 wordt verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe blobs worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.
function exists(options?: BlobExistsOptions): Promise<boolean>
Parameters
- options
- BlobExistsOptions
opties voor de bewerking Exists.
Retouren
Promise<boolean>
Overgenomen vanBlobClient.exists
generateSasUrl(BlobGenerateSasUrlOptions)
Alleen beschikbaar voor BlobClient die is gemaakt met een gedeelde sleutelreferentie.
Genereert een SAS-URI (Shared Access Signature) voor Blob Service op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>
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.
Overgenomen vanBlobClient.generateSasUrl
getAppendBlobClient()
Hiermee maakt u een AppendBlobClient-object.
function getAppendBlobClient(): AppendBlobClient
Retouren
Overgenomen vanBlobClient.getAppendBlobClient
getBlobLeaseClient(string)
Haal een BlobLeaseClient op die leases op de blob beheert.
function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient
Parameters
- proposeLeaseId
-
string
Initiële voorgestelde lease-id.
Retouren
Een nieuw BlobLeaseClient-object voor het beheren van leases op de blob.
Overgenomen vanBlobClient.getBlobLeaseClient
getBlockBlobClient()
Hiermee maakt u een BlockBlobClient-object.
function getBlockBlobClient(): BlockBlobClient
Retouren
Overgenomen vanBlobClient.getBlockBlobClient
getPageBlobClient()
Hiermee maakt u een PageBlobClient-object.
function getPageBlobClient(): PageBlobClient
Retouren
Overgenomen vanBlobClient.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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
WAARSCHUWING: het metadata
object dat in het antwoord wordt geretourneerd, heeft de sleutels in kleine letters, zelfs als deze oorspronkelijk hoofdletters bevatten. Dit wijkt af van de metagegevenssleutels die worden geretourneerd door de methoden van ContainerClient die blobs vermelden met behulp van de includeMetadata
optie, die hun oorspronkelijke hoofdletters behouden.
function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>
Parameters
- options
- BlobGetPropertiesOptions
Optionele opties voor de bewerking Eigenschappen ophalen.
Retouren
Promise<BlobGetPropertiesResponse>
Overgenomen vanBlobClient.getProperties
getTags(BlobGetTagsOptions)
Hiermee haalt u de tags op die zijn gekoppeld aan de onderliggende blob.
function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>
Parameters
- options
- BlobGetTagsOptions
Retouren
Promise<BlobGetTagsResponse>
Overgenomen vanBlobClient.getTags
setAccessTier(string, BlobSetTierOptions)
Hiermee stelt u de laag voor 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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>
Parameters
- tier
-
string
De laag die moet worden ingesteld voor de blob. Geldige waarden zijn Dynamisch, Statisch of Archief.
- options
- BlobSetTierOptions
Optionele opties voor de bewerking Blob-setlaag.
Retouren
Promise<BlobSetTierResponse>
Overgenomen vanBlobClient.setAccessTier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)
Hiermee stelt u systeemeigenschappen voor de blob in.
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 waarde gewist.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>
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 waarde gewist.
Een veelgebruikte header die moet worden ingesteld, is blobContentType
het inschakelen van de browser om functionaliteit te bieden op basis van het bestandstype.
- options
- BlobSetHTTPHeadersOptions
Optionele opties voor de bewerking HTTP-headers blob instellen.
Retouren
Promise<BlobSetHTTPHeadersResponse>
Overgenomen vanBlobClient.setHTTPHeaders
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Stel beleid voor onveranderbaarheid in op de blob.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>
Parameters
- immutabilityPolicy
- BlobImmutabilityPolicy
- options
- BlobSetImmutabilityPolicyOptions
Optionele opties voor het instellen van beleid voor onveranderbaarheid op de blob.
Retouren
Promise<BlobSetImmutabilityPolicyResponse>
Overgenomen vanBlobClient.setImmutabilityPolicy
setLegalHold(boolean, BlobSetLegalHoldOptions)
Stel juridische bewaring in voor de blob.
function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>
Parameters
- legalHoldEnabled
-
boolean
- options
- BlobSetLegalHoldOptions
Optionele opties voor het instellen van juridische bewaring voor de blob.
Retouren
Promise<BlobSetLegalHoldResponse>
Overgenomen vanBlobClient.setLegalHold
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 blobmetagegevens verwijderd.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>
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>
Overgenomen vanBlobClient.setMetadata
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): Promise<BlobSetTagsResponse>
Parameters
- tags
- Tags
- options
- BlobSetTagsOptions
Retouren
Promise<BlobSetTagsResponse>
Overgenomen vanBlobClient.setTags
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)
Met de synchrone bewerking Copy From URL kopieert u een blob of een internetbron naar een nieuwe blob. Er wordt pas een antwoord geretourneerd als het kopiëren is voltooid.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>
Parameters
- copySource
-
string
De bron-URL waaruit u wilt kopiëren, Shared Access Signature (SAS) die mogelijk nodig is voor verificatie
- options
- BlobSyncCopyFromURLOptions
Retouren
Promise<BlobCopyFromURLResponse>
Overgenomen vanBlobClient.syncCopyFromURL
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.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>
Parameters
- options
- BlobUndeleteOptions
Optionele opties voor de bewerking Blob ongedaan maken.
Retouren
Promise<BlobUndeleteResponse>
Overgenomen vanBlobClient.undelete
withVersion(string)
Hiermee maakt u een nieuw BlobClient-object dat verwijst naar een versie van deze blob. Als u opgeeft, wordt de versionId verwijderd en wordt een client geretourneerd naar de basis-blob.
function withVersion(versionId: string): BlobClient
Parameters
- versionId
-
string
De versionId.
Retouren
Een nieuw BlobClient-object dat verwijst naar de versie van deze blob.
Overgenomen vanBlobClient.withVersion