ContainerURL class

Paket:

@azure/storage-blob

En ContainerURL representerar en URL till Azure Storage-containern så att du kan ändra dess blobar.

Extends

StorageURL

Konstruktorer

ContainerURL(string, Pipeline)

Skapar en instans av ContainerURL.

Egenskaper

credential	Autentiseringsuppgifter som används för autentisering och auktorisering.
pipeline	Begär princippipeline.
url	Kodat URL-strängvärde.

Metoder

acquireLease(Aborter, string, number, IContainerAcquireLeaseOptions)	Upprättar och hanterar ett lås på en container för borttagningsåtgärder. Låsvaraktigheten kan vara mellan 15 och 60 sekunder, eller så kan den vara oändlig.
breakLease(Aborter, number, IContainerBreakLeaseOptions)	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, IContainerChangeLeaseOptions)	Ändra ID:t för ett befintligt lån.
create(Aborter, IContainerCreateOptions)	Skapar en ny container under det angivna kontot. Om containern med samma namn redan finns misslyckas åtgärden.
delete(Aborter, IContainerDeleteMethodOptions)	Markerar den angivna containern för borttagning. Containern och eventuella blobar som finns i den tas senare bort under skräpinsamlingen.
fromServiceURL(ServiceURL, string)	Skapar ett ContainerURL-objekt från ServiceURL
getAccessPolicy(Aborter, IContainerGetAccessPolicyOptions)	Hämtar behörigheterna för den angivna containern. Behörigheterna anger om containerdata kan kommas åt offentligt. VARNING! JavaScript-datum kan förlora precision vid parsning av start- och utgångssträng. Till exempel får nya Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z".
getProperties(Aborter, IContainerGetPropertiesOptions)	Returnerar alla användardefinierade metadata och systemegenskaper för den angivna containern. De data som returneras innehåller inte containerns lista över blobar.
listBlobFlatSegment(Aborter, undefined | string, IContainerListBlobsSegmentOptions)	listBlobFlatSegment returnerar ett enda segment med blobar från den angivna markören. Använd en tom markör för att starta uppräkning från början. När du har fått ett segment bearbetar du det och anropar sedan ListBlobsFlatSegment igen (skickar den tidigare returnerade markören) för att hämta nästa segment.
listBlobHierarchySegment(Aborter, string, undefined | string, IContainerListBlobsSegmentOptions)	listBlobHierarchySegment returnerar ett enda segment med blobar från den angivna markören. Använd en tom markör för att starta uppräkning från början. När du har fått ett segment bearbetar du det och anropar sedan ListBlobsHierarchicalSegment igen (skickar den tidigare returnerade markören) för att hämta nästa segment.
newPipeline(Credential, INewPipelineOptions)	En statisk metod som används för att skapa ett nytt pipelineobjekt med angivna autentiseringsuppgifter.
releaseLease(Aborter, string, IContainerReleaseLeaseOptions)	För att frigöra lånet om det inte längre behövs så att en annan klient omedelbart kan skaffa ett lån mot containern.
renewLease(Aborter, string, IContainerRenewLeaseOptions)	Förnya ett befintligt lån.
setAccessPolicy(Aborter, Models.PublicAccessType, ISignedIdentifier[], IContainerSetAccessPolicyOptions)	Anger behörigheter för den angivna containern. Behörigheterna anger om blobar i en container kan nås offentligt. När du anger behörigheter för en container ersätts de befintliga behörigheterna. Om ingen åtkomst eller containerAcl har angetts tas den befintliga container-ACL:n bort.
setMetadata(Aborter, IMetadata, IContainerSetMetadataOptions)	Anger ett eller flera användardefinierade namn/värde-par för den angivna containern. Om inget alternativ har angetts, eller om inga metadata har definierats i parametern, tas containermetadata bort.
withPipeline(Pipeline)	Skapar ett nytt ContainerURL-objekt som är identiskt med källan men med den angivna pipelinen för begärandeprincip.

Konstruktorinformation

ContainerURL(string, Pipeline)

Skapar en instans av ContainerURL.

new ContainerURL(url: string, pipeline: Pipeline)

Parametrar

url

string

En URL-sträng som pekar på En Azure Storage-blobcontainer, till exempel "https://myaccount.blob.core.windows.net/mycontainer". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.blob.core.windows.net/mycontainer?sasString".

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

Credential

pipeline

Begär princippipeline.

pipeline: Pipeline

Egenskapsvärde

Pipeline

url

Kodat URL-strängvärde.

url: string

Egenskapsvärde

string

Metodinformation

acquireLease(Aborter, string, number, IContainerAcquireLeaseOptions)

Upprättar och hanterar ett lås på en container för borttagningsåtgärder. Låsvaraktigheten kan vara mellan 15 och 60 sekunder, eller så kan den vara oändlig.

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

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

Måste vara mellan 15 och 60 sekunder eller oändligt (-1)

options

IContainerAcquireLeaseOptions

Returer

Promise<Models.ContainerAcquireLeaseResponse>

breakLease(Aborter, number, IContainerBreakLeaseOptions)

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, period: number, options?: IContainerBreakLeaseOptions)

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

period

number

brytperiod

options

IContainerBreakLeaseOptions

Returer

Promise<Models.ContainerBreakLeaseResponse>

changeLease(Aborter, string, string, IContainerChangeLeaseOptions)

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

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

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

options

IContainerChangeLeaseOptions

Returer

Promise<Models.ContainerChangeLeaseResponse>

create(Aborter, IContainerCreateOptions)

Skapar en ny container under det angivna kontot. Om containern med samma namn redan finns misslyckas åtgärden.

function create(aborter: Aborter, options?: IContainerCreateOptions)

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

options

IContainerCreateOptions

Returer

Promise<Models.ContainerCreateResponse>

delete(Aborter, IContainerDeleteMethodOptions)

Markerar den angivna containern för borttagning. Containern och eventuella blobar som finns i den tas senare bort under skräpinsamlingen.

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

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

options

IContainerDeleteMethodOptions

Returer

Promise<Models.ContainerDeleteResponse>

fromServiceURL(ServiceURL, string)

Skapar ett ContainerURL-objekt från ServiceURL

static function fromServiceURL(serviceURL: ServiceURL, containerName: string)

Parametrar

serviceURL

ServiceURL

Ett ServiceURL-objekt

containerName

string

Ett containernamn

Returer

ContainerURL

getAccessPolicy(Aborter, IContainerGetAccessPolicyOptions)

Hämtar behörigheterna för den angivna containern. Behörigheterna anger om containerdata kan kommas åt offentligt. VARNING! JavaScript-datum kan förlora precision vid parsning av start- och utgångssträng. Till exempel får nya Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z".

function getAccessPolicy(aborter: Aborter, options?: IContainerGetAccessPolicyOptions)

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

options

IContainerGetAccessPolicyOptions

Returer

Promise<ContainerGetAccessPolicyResponse>

getProperties(Aborter, IContainerGetPropertiesOptions)

Returnerar alla användardefinierade metadata och systemegenskaper för den angivna containern. De data som returneras innehåller inte containerns lista över blobar.

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

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

options

IContainerGetPropertiesOptions

Returer

Promise<Models.ContainerGetPropertiesResponse>

listBlobFlatSegment(Aborter, undefined | string, IContainerListBlobsSegmentOptions)

listBlobFlatSegment returnerar ett enda segment med blobar från den angivna markören. Använd en tom markör för att starta uppräkning från början. När du har fått ett segment bearbetar du det och anropar sedan ListBlobsFlatSegment igen (skickar den tidigare returnerade markören) för att hämta nästa segment.

function listBlobFlatSegment(aborter: Aborter, marker?: undefined | string, options?: IContainerListBlobsSegmentOptions)

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

marker

undefined | string

options

IContainerListBlobsSegmentOptions

Returer

Promise<Models.ContainerListBlobFlatSegmentResponse>

listBlobHierarchySegment(Aborter, string, undefined | string, IContainerListBlobsSegmentOptions)

listBlobHierarchySegment returnerar ett enda segment med blobar från den angivna markören. Använd en tom markör för att starta uppräkning från början. När du har fått ett segment bearbetar du det och anropar sedan ListBlobsHierarchicalSegment igen (skickar den tidigare returnerade markören) för att hämta nästa segment.

function listBlobHierarchySegment(aborter: Aborter, delimiter: string, marker?: undefined | string, options?: IContainerListBlobsSegmentOptions)

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

delimiter

string

marker

undefined | string

options

IContainerListBlobsSegmentOptions

Returer

Promise<Models.ContainerListBlobHierarchySegmentResponse>

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

Pipeline

Ett nytt pipelineobjekt.

releaseLease(Aborter, string, IContainerReleaseLeaseOptions)

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

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

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

options

IContainerReleaseLeaseOptions

Returer

Promise<Models.ContainerReleaseLeaseResponse>

renewLease(Aborter, string, IContainerRenewLeaseOptions)

Förnya ett befintligt lån.

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

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

options

IContainerRenewLeaseOptions

Returer

Promise<Models.ContainerRenewLeaseResponse>

setAccessPolicy(Aborter, Models.PublicAccessType, ISignedIdentifier[], IContainerSetAccessPolicyOptions)

Anger behörigheter för den angivna containern. Behörigheterna anger om blobar i en container kan nås offentligt. När du anger behörigheter för en container ersätts de befintliga behörigheterna. Om ingen åtkomst eller containerAcl har angetts tas den befintliga container-ACL:n bort.

function setAccessPolicy(aborter: Aborter, access?: Models.PublicAccessType, containerAcl?: ISignedIdentifier[], options?: IContainerSetAccessPolicyOptions)

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

access

Models.PublicAccessType

containerAcl

ISignedIdentifier[]

options

IContainerSetAccessPolicyOptions

Returer

Promise<Models.ContainerSetAccessPolicyResponse>

setMetadata(Aborter, IMetadata, IContainerSetMetadataOptions)

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

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

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

options

IContainerSetMetadataOptions

Returer

Promise<Models.ContainerSetMetadataResponse>

withPipeline(Pipeline)

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

function withPipeline(pipeline: Pipeline)

Parametrar

pipeline

Pipeline

Returer

ContainerURL