Dela via


BlobURL class

En BlobURL representerar en URL till en Azure Storage-blob. bloben kan vara en blockblob, en tilläggsblob eller en sidblob.

Extends

Konstruktorer

BlobURL(string, Pipeline)

Skapar en instans av BlobURL. 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. Om ett blobnamn innehåller ? eller %måste blobnamnet kodas i URL:en.

Egenskaper

credential

Autentiseringsuppgifter som används för autentisering och auktorisering.

pipeline

Begär princippipeline.

url

Kodat URL-strängvärde.

Metoder

abortCopyFromURL(Aborter, string, IBlobAbortCopyFromURLOptions)

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.

acquireLease(Aborter, string, number, IBlobAcquireLeaseOptions)

Upprättar och hanterar ett lås på en blob för skriv- och borttagningsåtgärder. Låsvaraktigheten kan vara mellan 15 och 60 sekunder, eller så kan den vara oändlig. I versioner före 2012-02-12 är låsvaraktigheten 60 sekunder.

breakLease(Aborter, undefined | number, IBlobBreakLeaseOptions)

Avsluta lånet men se till att en annan klient inte kan skaffa ett nytt lån förrän den aktuella låneperioden har upphört att gälla.

changeLease(Aborter, string, string, IBlobChangeLeaseOptions)

Ändra ID:t för ett befintligt lån.

createSnapshot(Aborter, IBlobCreateSnapshotOptions)

Skapar en skrivskyddad ögonblicksbild av en blob.

delete(Aborter, IBlobDeleteOptions)

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.

download(Aborter, number, undefined | number, IBlobDownloadOptions)

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.jsreturnerar data i en läsbar dataström readableStreamBody
  • I webbläsare returneras data i en löftesblobKropp
fromContainerURL(ContainerURL, string)

Skapar ett BlobURL-objekt från ett ContainerURL-objekt.

getProperties(Aborter, IBlobGetPropertiesOptions)

Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för bloben. Det returnerar inte innehållet i bloben.

newPipeline(Credential, INewPipelineOptions)

En statisk metod som används för att skapa ett nytt pipelineobjekt med angivna autentiseringsuppgifter.

releaseLease(Aborter, string, IBlobReleaseLeaseOptions)

Frigör lånet om det inte längre behövs så att en annan klient omedelbart kan skaffa ett lån mot bloben.

renewLease(Aborter, string, IBlobRenewLeaseOptions)

Förnya ett befintligt lån.

setHTTPHeaders(Aborter, Models.BlobHTTPHeaders, IBlobSetHTTPHeadersOptions)

Anger systemegenskaper på bloben. Om inget värde anges, eller inget värde som anges för de specifika HTTP-blobhuvudena, rensas dessa HTTP-blobhuvuden utan värde.

setMetadata(Aborter, IMetadata, IBlobSetMetadataOptions)

Anger användardefinierade metadata för den angivna bloben som ett eller flera namn/värde-par. Om inget alternativ har angetts, eller om inga metadata har definierats i parametern, tas blobmetadata bort.

setTier(Aborter, BlockBlobTier | PremiumPageBlobTier | string, IBlobSetTierOptions)

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-sidblobnivå avgör blobens tillåtna storlek, IOPS och bandbredd. En blockblobnivå avgör lagringstypen Frekvent/Lågfrekvent/Arkiv. Den här åtgärden uppdaterar inte blobens ETag.

startCopyFromURL(Aborter, string, IBlobStartCopyFromURLOptions)

Kopierar asynkront en blob till ett mål i lagringskontot. I version 2012-02-12 och senare kan källan för en kopieringsblobåtgärd vara en bekräftad blob i valfritt Azure-lagringskonto. 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.

syncCopyFromURL(Aborter, string, IBlobSyncCopyFromURLOptions)

Åtgärden Kopiera från URL kopierar en blob eller en Internetresurs till en ny blob. Det returnerar inte något svar förrän kopian är klar.

undelete(Aborter)

Återställer innehållet och metadata för mjuk borttagen blob och eventuella associerade mjuka borttagna ögonblicksbilder. Undelete Blob stöds endast i version 2017-07-29 eller senare.

withPipeline(Pipeline)

Skapar ett nytt BlobURL-objekt som är identiskt med källan men med den angivna pipelinen för begärandeprincip.

withSnapshot(string)

Skapar ett nytt BlobURL-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilder. Ange "" tar bort ögonblicksbilden och returnerar en URL till basbloben.

Konstruktorinformation

BlobURL(string, Pipeline)

Skapar en instans av BlobURL. 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. Om ett blobnamn innehåller ? eller %måste blobnamnet kodas i URL:en.

new BlobURL(url: string, pipeline: Pipeline)

Parametrar

url

string

En URL-sträng som pekar på Azure Storage-blob, till exempel "https://myaccount.blob.core.windows.net/mycontainer/blob". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.blob.core.windows.net/mycontainer/blob?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 %måste blobnamnet kodas 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
Pipeline

Anropa StorageURL.newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.

Egenskapsinformation

credential

Autentiseringsuppgifter som används för autentisering och auktorisering.

credential: Credential

Egenskapsvärde

pipeline

Begär princippipeline.

pipeline: Pipeline

Egenskapsvärde

url

Kodat URL-strängvärde.

url: string

Egenskapsvärde

string

Metodinformation

abortCopyFromURL(Aborter, string, IBlobAbortCopyFromURLOptions)

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.

function abortCopyFromURL(aborter: Aborter, copyId: string, options?: IBlobAbortCopyFromURLOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

copyId

string

Returer

Promise<Models.BlobAbortCopyFromURLResponse>

acquireLease(Aborter, string, number, IBlobAcquireLeaseOptions)

Upprättar och hanterar ett lås på en blob för skriv- och borttagningsåtgärder. Låsvaraktigheten kan vara mellan 15 och 60 sekunder, eller så kan den vara oändlig. I versioner före 2012-02-12 är låsvaraktigheten 60 sekunder.

function acquireLease(aborter: Aborter, proposedLeaseId: string, duration: number, options?: IBlobAcquireLeaseOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

proposedLeaseId

string

Kan anges i valfritt giltigt GUID-strängformat

duration

number

Låsvaraktigheten kan vara 15 till 60 sekunder eller vara oändlig

Returer

Promise<Models.BlobAcquireLeaseResponse>

breakLease(Aborter, undefined | number, IBlobBreakLeaseOptions)

Avsluta lånet men se till att en annan klient inte kan skaffa ett nytt lån förrän den aktuella låneperioden har upphört att gälla.

function breakLease(aborter: Aborter, breakPeriod?: undefined | number, options?: IBlobBreakLeaseOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

breakPeriod

undefined | number

Returer

Promise<Models.BlobBreakLeaseResponse>

changeLease(Aborter, string, string, IBlobChangeLeaseOptions)

Ändra ID:t för ett befintligt lån.

function changeLease(aborter: Aborter, leaseId: string, proposedLeaseId: string, options?: IBlobChangeLeaseOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

leaseId

string

proposedLeaseId

string

Returer

Promise<Models.BlobChangeLeaseResponse>

createSnapshot(Aborter, IBlobCreateSnapshotOptions)

Skapar en skrivskyddad ögonblicksbild av en blob.

function createSnapshot(aborter: Aborter, options?: IBlobCreateSnapshotOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

Returer

Promise<Models.BlobCreateSnapshotResponse>

delete(Aborter, IBlobDeleteOptions)

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.

function delete(aborter: Aborter, options?: IBlobDeleteOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

Returer

Promise<Models.BlobDeleteResponse>

download(Aborter, number, undefined | number, IBlobDownloadOptions)

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.jsreturnerar data i en läsbar dataström readableStreamBody
  • I webbläsare returneras data i en löftesblobKropp
function download(aborter: Aborter, offset: number, count?: undefined | number, options?: IBlobDownloadOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

offset

number

Från vilken position bloben ska laddas ned >= 0

count

undefined | number

Returer

Promise<Models.BlobDownloadResponse>

fromContainerURL(ContainerURL, string)

Skapar ett BlobURL-objekt från ett ContainerURL-objekt.

static function fromContainerURL(containerURL: ContainerURL, blobName: string)

Parametrar

containerURL
ContainerURL

Ett ContainerURL-objekt

blobName

string

Ett blobnamn

Returer

getProperties(Aborter, IBlobGetPropertiesOptions)

Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för bloben. Det returnerar inte innehållet i bloben.

function getProperties(aborter: Aborter, options?: IBlobGetPropertiesOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

Returer

Promise<Models.BlobGetPropertiesResponse>

newPipeline(Credential, INewPipelineOptions)

En statisk metod som används för att skapa ett nytt pipelineobjekt med angivna autentiseringsuppgifter.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions)

Parametrar

credential
Credential

Till exempel AnonymousCredential, SharedKeyCredential eller TokenCredential.

pipelineOptions
INewPipelineOptions

Returer

Ett nytt pipelineobjekt.

releaseLease(Aborter, string, IBlobReleaseLeaseOptions)

Frigör lånet om det inte längre behövs så att en annan klient omedelbart kan skaffa ett lån mot bloben.

function releaseLease(aborter: Aborter, leaseId: string, options?: IBlobReleaseLeaseOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

leaseId

string

Returer

Promise<Models.BlobReleaseLeaseResponse>

renewLease(Aborter, string, IBlobRenewLeaseOptions)

Förnya ett befintligt lån.

function renewLease(aborter: Aborter, leaseId: string, options?: IBlobRenewLeaseOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

leaseId

string

Returer

Promise<Models.BlobRenewLeaseResponse>

setHTTPHeaders(Aborter, Models.BlobHTTPHeaders, IBlobSetHTTPHeadersOptions)

Anger systemegenskaper på bloben. Om inget värde anges, eller inget värde som anges för de specifika HTTP-blobhuvudena, rensas dessa HTTP-blobhuvuden utan värde.

function setHTTPHeaders(aborter: Aborter, blobHTTPHeaders?: Models.BlobHTTPHeaders, options?: IBlobSetHTTPHeadersOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

blobHTTPHeaders
Models.BlobHTTPHeaders

Returer

Promise<Models.BlobSetHTTPHeadersResponse>

setMetadata(Aborter, IMetadata, IBlobSetMetadataOptions)

Anger användardefinierade metadata för den angivna bloben som ett eller flera namn/värde-par. Om inget alternativ har angetts, eller om inga metadata har definierats i parametern, tas blobmetadata bort.

function setMetadata(aborter: Aborter, metadata?: IMetadata, options?: IBlobSetMetadataOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

metadata
IMetadata

Returer

Promise<Models.BlobSetMetadataResponse>

setTier(Aborter, BlockBlobTier | PremiumPageBlobTier | string, IBlobSetTierOptions)

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-sidblobnivå avgör blobens tillåtna storlek, IOPS och bandbredd. En blockblobnivå avgör lagringstypen Frekvent/Lågfrekvent/Arkiv. Den här åtgärden uppdaterar inte blobens ETag.

function setTier(aborter: Aborter, tier: BlockBlobTier | PremiumPageBlobTier | string, options?: IBlobSetTierOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

Returer

Promise<Models.BlobSetTierResponse>

startCopyFromURL(Aborter, string, IBlobStartCopyFromURLOptions)

Kopierar asynkront en blob till ett mål i lagringskontot. I version 2012-02-12 och senare kan källan för en kopieringsblobåtgärd vara en bekräftad blob i valfritt Azure-lagringskonto. 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.

function startCopyFromURL(aborter: Aborter, copySource: string, options?: IBlobStartCopyFromURLOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

copySource

string

Returer

Promise<Models.BlobStartCopyFromURLResponse>

syncCopyFromURL(Aborter, string, IBlobSyncCopyFromURLOptions)

Åtgärden Kopiera från URL kopierar en blob eller en Internetresurs till en ny blob. Det returnerar inte något svar förrän kopian är klar.

function syncCopyFromURL(aborter: Aborter, copySource: string, options?: IBlobSyncCopyFromURLOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

copySource

string

Käll-URL:en som ska kopieras från, signatur för delad åtkomst (SAS) kanske behövs för autentisering

Returer

Promise<Models.BlobCopyFromURLResponse>

undelete(Aborter)

Återställer innehållet och metadata för mjuk borttagen blob och eventuella associerade mjuka borttagna ögonblicksbilder. Undelete Blob stöds endast i version 2017-07-29 eller senare.

function undelete(aborter: Aborter)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

Returer

Promise<Models.BlobUndeleteResponse>

withPipeline(Pipeline)

Skapar ett nytt BlobURL-objekt som är identiskt med källan men med den angivna pipelinen för begärandeprincip.

function withPipeline(pipeline: Pipeline)

Parametrar

pipeline
Pipeline

Returer

withSnapshot(string)

Skapar ett nytt BlobURL-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilder. Ange "" tar bort ögonblicksbilden och returnerar en URL till basbloben.

function withSnapshot(snapshot: string)

Parametrar

snapshot

string

Returer

Ett nytt BlobURL-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilder