@azure/storage-blob package
Klasser
AccountSASPermissions |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att konstruera en sträng som representerar de behörigheter som beviljas av en AccountSAS. Om ett värde anges till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet på ett <xref:AccountSASSignatureValues> objekt. Det går att konstruera behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet. |
AccountSASResourceTypes |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att konstruera en sträng som representerar de resurser som är tillgängliga för en AccountSAS. Om du anger värdet true innebär det att alla SAS som använder dessa behörigheter ger åtkomst till den resurstypen. När alla värden har angetts ska detta serialiseras med toString och anges som resursfält i ett <xref:AccountSASSignatureValues>-objekt. Det går att konstruera resurssträngen utan den här klassen, men resursordningen är speciell och den här klassen garanterar korrekthet. |
AccountSASServices |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att konstruera en sträng som representerar de tjänster som är tillgängliga för en AccountSAS. Om du anger värdet true innebär det att alla SAS som använder dessa behörigheter ger åtkomst till den tjänsten. När alla värden har angetts ska detta serialiseras med toString och anges som tjänstfältet på ett <xref:AccountSASSignatureValues> objekt. Det går att konstruera tjänstesträngen utan den här klassen, men ordningen på tjänsterna är speciell och den här klassen garanterar korrekthet. |
AnonymousCredential |
AnonymousCredential tillhandahåller en credentialPolicyCreator-medlem som används för att skapa AnonymousCredentialPolicy-objekt. AnonymousCredentialPolicy används med HTTP-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS). |
AnonymousCredentialPolicy |
AnonymousCredentialPolicy används med HTTP-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS). |
AppendBlobClient |
AppendBlobClient definierar en uppsättning åtgärder som gäller för tilläggsblobar. |
BlobBatch |
En BlobBatch representerar en aggregerad uppsättning åtgärder på blobar.
För närvarande stöds endast |
BlobBatchClient |
Med En BlobBatchClient kan du göra batchbegäranden till Azure Storage Blob-tjänsten. |
BlobClient |
En BlobClient representerar en URL till en Azure Storage-blob. bloben kan vara en blockblob, en tilläggsblob eller en sidblob. |
BlobLeaseClient |
En klient som hanterar lån för en <xref:ContainerClient> eller en <xref:BlobClient>. |
BlobSASPermissions |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att konstruera en sträng som representerar de behörigheter som beviljas av en ServiceSAS till en blob. Om ett värde anges till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet på ett <xref:BlobSASSignatureValues> objekt. Det går att konstruera behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet. |
BlobServiceClient |
En BlobServiceClient representerar en klient till Azure Storage Blob-tjänsten så att du kan ändra blobcontainrar. |
BlockBlobClient |
BlockBlobClient definierar en uppsättning åtgärder som gäller för blockblobar. |
ContainerClient |
En ContainerClient representerar en URL till Azure Storage-containern så att du kan ändra dess blobar. |
ContainerSASPermissions |
Det här är en hjälpklass för att konstruera en sträng som representerar de behörigheter som beviljas av en ServiceSAS till en container. Om ett värde anges till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet på ett <xref:BlobSASSignatureValues> objekt. Det går att konstruera behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet. |
Credential |
Autentiseringsuppgifter är en abstrakt klass för signering av HTTP-begäranden i Azure Storage. Den här klassen är värd för en credentialPolicyCreator-fabrik som genererar CredentialPolicy. |
CredentialPolicy |
Princip för autentiseringsuppgifter som används för att signera HTTP-begäranden (S) innan de skickas. Det här är en abstrakt klass. |
PageBlobClient |
PageBlobClient definierar en uppsättning åtgärder som gäller för sidblobbar. |
Pipeline |
En Pipeline-klass som innehåller HTTP-begärandeprinciper. Du kan skapa en standardpipeline genom att anropa <xref:newPipeline>. Eller så kan du skapa en pipeline med dina egna principer av konstruktorn för Pipeline. Se <xref:newPipeline> och tillhandahållna principer innan du implementerar din anpassade pipeline. |
SASQueryParameters |
Representerar de komponenter som utgör en Azure Storage SAS-frågeparametrar. Den här typen skapas inte direkt av användaren. Den genereras endast av <xref:AccountSASSignatureValues>- och <xref:BlobSASSignatureValues>-typerna. När den har genererats kan den kodas till en <xref:String> och läggas till direkt i en URL (även om försiktighet bör vidtas här om det finns befintliga frågeparametrar, vilket kan påverka lämpliga sätt att lägga till dessa frågeparametrar). Obs! Instanser av den här klassen är oföränderliga. |
StorageBrowserPolicy |
StorageBrowserPolicy hanterar skillnader mellan Node.js och webbläsarkörning, inklusive:
|
StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory är en fabriksklass som hjälper till att generera StorageBrowserPolicy-objekt. |
StorageClient |
En StorageClient representerar en baserad URL-klass för <xref:BlobServiceClient>, <xref:ContainerClient> och så vidare. |
StorageClientContext | |
StorageRetryPolicy |
Återförsöksprincip med exponentiellt återförsök och linjärt återförsök implementerat. |
StorageRetryPolicyFactory |
StorageRetryPolicyFactory är en fabriksklass som hjälper till att generera <xref:StorageRetryPolicy> objekt. |
StorageSharedKeyCredential |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. StorageSharedKeyCredential för kontonyckelauktorisering av Azure Storage-tjänsten. |
StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy är en princip som används för att signera HTTP-begäran med en delad nyckel. |
Gränssnitt
AccessPolicy |
En åtkomstprincip |
AccountSASPermissionsLike |
En typ som ser ut som en SAS-behörighet för kontot. Används i <xref:AccountSASPermissions> för att parsa SAS-behörigheter från råa objekt. |
AccountSASSignatureValues |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. AccountSASSignatureValues används för att generera en signatur för delad åtkomst (SAS) för ett Azure Storage-konto. När alla värden här har angetts på rätt sätt anropar du <xref:generateAccountSASQueryParameters> för att hämta en representation av SAS som faktiskt kan tillämpas på blob-URL:er. Obs! Att både den här klassen och <xref:SASQueryParameters> finns eftersom den förra är föränderlig och en logisk representation medan den senare är oföränderlig och används för att generera faktiska REST-begäranden. |
AppendBlobAppendBlockFromURLOptions |
Alternativ för att konfigurera åtgärden <xref:AppendBlobClient.appendBlockFromURL>. |
AppendBlobAppendBlockFromUrlHeaders |
Definierar rubriker för AppendBlob_appendBlockFromUrl åtgärd. |
AppendBlobAppendBlockHeaders |
Definierar rubriker för AppendBlob_appendBlock åtgärd. |
AppendBlobAppendBlockOptions |
Alternativ för att konfigurera åtgärden <xref:AppendBlobClient.appendBlock>. |
AppendBlobCreateHeaders |
Definierar rubriker för AppendBlob_create åtgärd. |
AppendBlobCreateIfNotExistsOptions |
Alternativ för att konfigurera <xref:AppendBlobClient.createIfNotExists> åtgärd. |
AppendBlobCreateIfNotExistsResponse |
Innehåller svarsdata för åtgärden <xref:appendBlobClient.createIfNotExists>. |
AppendBlobCreateOptions |
Alternativ för att konfigurera <xref:AppendBlobClient.create> åtgärd. |
AppendBlobRequestConditions |
Villkor som ska läggas till i skapandet av den här tilläggsbloben. |
AppendBlobSealOptions |
Alternativ för att konfigurera <xref:AppendBlobClient.seal> åtgärd. |
AppendPositionAccessConditions |
Parametergrupp |
BatchSubRequest |
En begäran som är associerad med en batchåtgärd. |
BatchSubResponse |
Svarsdata som är associerade med en enskild begäran i en batchåtgärd. |
BlobAbortCopyFromURLHeaders |
Definierar rubriker för Blob_abortCopyFromURL åtgärd. |
BlobAbortCopyFromURLOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.abortCopyFromURL>. |
BlobAcquireLeaseOptions |
Alternativ för att konfigurera Blob – Hämta låneåtgärd. |
BlobBatchSubmitBatchOptionalParams |
Alternativ för att konfigurera tjänsten – Skicka valfria Params för Batch. |
BlobBeginCopyFromURLOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.beginCopyFromURL>. |
BlobBeginCopyFromURLResponse |
Innehåller svarsdata för åtgärden <xref:BlobClient.beginCopyFromURL>. |
BlobBeginCopyFromUrlPollState |
Det tillstånd som används av pollern som returneras från <xref:BlobClient.beginCopyFromURL>.
Det här tillståndet skickas till den användardefinierade |
BlobBreakLeaseOptions |
Alternativ för att konfigurera blob – avbryt låneåtgärden. |
BlobChangeLeaseOptions |
Alternativ för att konfigurera Blob – Ändra låneåtgärd. |
BlobCopyFromURLHeaders |
Definierar rubriker för Blob_copyFromURL åtgärd. |
BlobCreateSnapshotHeaders |
Definierar rubriker för Blob_createSnapshot åtgärd. |
BlobCreateSnapshotOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.createSnapshot>. |
BlobDeleteHeaders |
Definierar rubriker för Blob_delete åtgärd. |
BlobDeleteIfExistsResponse |
Innehåller svarsdata för åtgärden <xref:BlobClient.deleteIfExists>. |
BlobDeleteImmutabilityPolicyHeaders |
Definierar rubriker för Blob_deleteImmutabilityPolicy åtgärd. |
BlobDeleteImmutabilityPolicyOptions |
Alternativ för att ta bort oföränderlighetsprincipen <xref:BlobClient.deleteImmutabilityPolicy> åtgärd. |
BlobDeleteOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.delete>. |
BlobDownloadHeaders |
Definierar rubriker för Blob_download åtgärd. |
BlobDownloadOptionalParams |
Valfria parametrar. |
BlobDownloadOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.download>. |
BlobDownloadResponseParsed |
Innehåller svarsdata för åtgärden <xref:BlobClient.download>. |
BlobDownloadToBufferOptions |
Alternativgränssnitt för åtgärden <xref:BlobClient.downloadToBuffer>. |
BlobExistsOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.exists>. |
BlobFlatListSegment |
Ett gränssnitt som representerar BlobFlatListSegment. |
BlobFlatListSegmentModel | |
BlobGenerateSasUrlOptions |
Alternativ för att konfigurera <xref:BlobClient.generateSasUrl> åtgärd. |
BlobGetPropertiesHeaders |
Definierar rubriker för Blob_getProperties åtgärd. |
BlobGetPropertiesOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.getProperties>. |
BlobGetPropertiesResponse |
Innehåller svarsdata för åtgärden <xref:BlobClient.getProperties>. |
BlobGetTagsHeaders |
Definierar rubriker för Blob_getTags åtgärd. |
BlobGetTagsOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.getTags>. |
BlobHTTPHeaders |
Parametergrupp |
BlobHierarchyListSegment |
Ett gränssnitt som representerar BlobHierarchyListSegment. |
BlobHierarchyListSegmentModel | |
BlobImmutabilityPolicy |
Beskriv oföränderlig princip för blob. |
BlobItem |
En Azure Storage-blob |
BlobItemInternal |
En Azure Storage-blob |
BlobPrefix | |
BlobProperties |
Egenskaper för en blob |
BlobQueryArrowConfiguration |
Alternativ för att fråga blob med Apache Arrow-format. Gäller endast för <xref:BlockBlobQueryOptions.outputTextConfiguration>. |
BlobQueryArrowField |
Beskriva ett fält i <xref:BlobQueryArrowConfiguration>. |
BlobQueryCsvTextConfiguration |
Alternativ för att fråga blob med CSV-format. |
BlobQueryError |
Feltyp för blobfråga. |
BlobQueryHeaders |
Definierar rubriker för Blob_query åtgärd. |
BlobQueryJsonTextConfiguration |
Alternativ för att fråga blob med JSON-format. |
BlobQueryParquetConfiguration |
Alternativ för att fråga blob med Parquet-format. Gäller endast för <xref:BlockBlobQueryOptions.inputTextConfiguration>. |
BlobReleaseLeaseOptions |
Alternativ för att konfigurera åtgärden Blob – Release Lease. |
BlobRenewLeaseOptions |
Alternativ för att konfigurera Blob – Förnya låneåtgärd. |
BlobRequestConditions |
villkor och lånevillkor för STANDARD HTTP-villkorsrubriker, taggar |
BlobSASPermissionsLike |
En typ som ser ut som en Blob SAS-behörighet. Används i <xref:BlobSASPermissions> för att parsa SAS-behörigheter från råa objekt. |
BlobSASSignatureValues |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. BlobSASSignatureValues används för att generera SAS-token för blobtjänsten för containrar eller blobar. |
BlobServiceProperties |
Egenskaper för lagringstjänsten. |
BlobServiceStatistics |
Statistik för lagringstjänsten. |
BlobSetHTTPHeadersHeaders |
Definierar rubriker för Blob_setHttpHeaders åtgärd. |
BlobSetHTTPHeadersOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.setHTTPHeaders>. |
BlobSetImmutabilityPolicyHeaders |
Definierar rubriker för Blob_setImmutabilityPolicy åtgärd. |
BlobSetImmutabilityPolicyOptions |
Alternativ för att ange oföränderlighetsprincip <xref:BlobClient.setImmutabilityPolicy> åtgärd. |
BlobSetLegalHoldHeaders |
Definierar rubriker för Blob_setLegalHold åtgärd. |
BlobSetLegalHoldOptions |
Alternativ för att ange bevarande av juridiska skäl <xref:BlobClient.setLegalHold> åtgärd. |
BlobSetMetadataHeaders |
Definierar rubriker för Blob_setMetadata åtgärd. |
BlobSetMetadataOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.setMetadata>. |
BlobSetTagsHeaders |
Definierar rubriker för Blob_setTags åtgärd. |
BlobSetTagsOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.setTags>. |
BlobSetTierHeaders |
Definierar rubriker för Blob_setTier åtgärd. |
BlobSetTierOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.setAccessTier>. |
BlobStartCopyFromURLHeaders |
Definierar rubriker för Blob_startCopyFromURL åtgärd. |
BlobStartCopyFromURLOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.beginCopyFromURL>. |
BlobSyncCopyFromURLOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.syncCopyFromURL>. |
BlobTag | |
BlobTags |
Blobtaggar |
BlobUndeleteHeaders |
Definierar rubriker för Blob_undelete åtgärd. |
BlobUndeleteOptions |
Alternativ för att konfigurera åtgärden <xref:BlobClient.undelete>. |
Block |
Representerar ett enda block i en blockblob. Den beskriver blockets ID och storlek. |
BlockBlobCommitBlockListHeaders |
Definierar rubriker för BlockBlob_commitBlockList åtgärd. |
BlockBlobCommitBlockListOptions |
Alternativ för att konfigurera <xref:BlockBlobClient.commitBlockList> åtgärd. |
BlockBlobGetBlockListHeaders |
Definierar rubriker för BlockBlob_getBlockList åtgärd. |
BlockBlobGetBlockListOptions |
Alternativ för att konfigurera <xref:BlockBlobClient.getBlockList> åtgärd. |
BlockBlobParallelUploadOptions |
Alternativgränssnitt för <xref:BlockBlobClient.uploadFile> och <xref:BlockBlobClient.uploadSeekableStream>. |
BlockBlobPutBlobFromUrlHeaders |
Definierar rubriker för BlockBlob_putBlobFromUrl åtgärd. |
BlockBlobQueryOptions |
Alternativ för att konfigurera <xref:BlockBlobClient.query> åtgärd. |
BlockBlobStageBlockFromURLHeaders |
Definierar rubriker för BlockBlob_stageBlockFromURL åtgärd. |
BlockBlobStageBlockFromURLOptions |
Alternativ för att konfigurera <xref:BlockBlobClient.stageBlockFromURL> åtgärd. |
BlockBlobStageBlockHeaders |
Definierar rubriker för BlockBlob_stageBlock åtgärd. |
BlockBlobStageBlockOptions |
Alternativ för att konfigurera <xref:BlockBlobClient.stageBlock> åtgärd. |
BlockBlobSyncUploadFromURLOptions |
Alternativ för att konfigurera <xref:BlockBlobClient.syncUploadFromURL> åtgärd. |
BlockBlobUploadHeaders |
Definierar rubriker för BlockBlob_upload åtgärd. |
BlockBlobUploadOptions |
Alternativ för att konfigurera <xref:BlockBlobClient.upload> åtgärd. |
BlockBlobUploadStreamOptions |
Alternativgränssnitt för åtgärden <xref:BlockBlobClient.uploadStream>. |
BlockList | |
CommonGenerateSasUrlOptions |
Vanliga alternativ för <xref:BlobGenerateSasUrlOptions> och <xref:ContainerGenerateSasUrlOptions>. |
CommonOptions |
Ett gränssnitt för alternativ som är gemensamma för varje fjärråtgärd. |
ContainerAcquireLeaseOptions |
Alternativ för att konfigurera container – Hämta låneåtgärd. |
ContainerBreakLeaseOptionalParams |
Valfria parametrar. |
ContainerBreakLeaseOptions |
Alternativ för att konfigurera container – Avbryt låneåtgärd. |
ContainerChangeLeaseOptions |
Alternativ för att konfigurera container – Ändra låneåtgärd. |
ContainerCreateHeaders |
Definierar rubriker för Container_create åtgärd. |
ContainerCreateIfNotExistsResponse |
Innehåller svarsdata för åtgärden <xref:ContainerClient.createIfNotExists>. |
ContainerCreateOptions |
Alternativ för att konfigurera <xref:ContainerClient.create> åtgärd. |
ContainerDeleteBlobOptions |
Alternativ för att konfigurera åtgärden <xref:ContainerClient.deleteBlob>. |
ContainerDeleteHeaders |
Definierar rubriker för Container_delete åtgärd. |
ContainerDeleteIfExistsResponse |
Innehåller svarsdata för åtgärden <xref:ContainerClient.deleteIfExists>. |
ContainerDeleteMethodOptions |
Alternativ för att konfigurera <xref:ContainerClient.delete> åtgärd. |
ContainerEncryptionScope |
Parametergrupp |
ContainerExistsOptions |
Alternativ för att konfigurera <xref:ContainerClient.exists> åtgärd. |
ContainerGenerateSasUrlOptions |
Alternativ för att konfigurera <xref:ContainerClient.generateSasUrl> åtgärd. |
ContainerGetAccessPolicyHeaders |
Definierar rubriker för Container_getAccessPolicy åtgärd. |
ContainerGetAccessPolicyOptions |
Alternativ för att konfigurera <xref:ContainerClient.getAccessPolicy> åtgärd. |
ContainerGetPropertiesHeaders |
Definierar rubriker för Container_getProperties åtgärd. |
ContainerGetPropertiesOptions |
Alternativ för att konfigurera <xref:ContainerClient.getProperties> åtgärd. |
ContainerItem |
En Azure Storage-container |
ContainerListBlobFlatSegmentHeaders |
Definierar rubriker för Container_listBlobFlatSegment åtgärd. |
ContainerListBlobHierarchySegmentHeaders |
Definierar rubriker för Container_listBlobHierarchySegment åtgärd. |
ContainerListBlobsOptions |
Alternativ för att konfigurera åtgärder för container – Lista blobar. Se:
|
ContainerProperties |
Egenskaper för en container |
ContainerReleaseLeaseOptions |
Alternativ för att konfigurera container – versionslåneåtgärd. |
ContainerRenameHeaders |
Definierar rubriker för Container_rename åtgärd. |
ContainerRenewLeaseOptions |
Alternativ för att konfigurera container – Förnya låneåtgärd. |
ContainerRequestConditions |
Villkor som ska uppfyllas för containern. |
ContainerSASPermissionsLike |
En typ som ser ut som en CONTAINER SAS-behörighet. Används i <xref:ContainerSASPermissions> för att parsa SAS-behörigheter från råa objekt. |
ContainerSetAccessPolicyHeaders |
Definierar rubriker för Container_setAccessPolicy åtgärd. |
ContainerSetAccessPolicyOptions |
Alternativ för att konfigurera <xref:ContainerClient.setAccessPolicy> åtgärd. |
ContainerSetMetadataHeaders |
Definierar rubriker för Container_setMetadata åtgärd. |
ContainerSetMetadataOptions |
Alternativ för att konfigurera <xref:ContainerClient.setMetadata> åtgärd. |
ContainerUndeleteHeaders |
Definierar rubriker för Container_restore åtgärd. |
CorsRule |
CORS är en HTTP-funktion som gör att ett webbprogram som körs under en domän kan komma åt resurser i en annan domän. Webbläsare implementerar en säkerhetsbegränsning som kallas samma ursprungsprincip som förhindrar att en webbsida anropar API:er i en annan domän. CORS är ett säkert sätt att tillåta att en domän (ursprungsdomänen) anropar API:er i en annan domän |
CpkInfo |
Parametergrupp |
FilterBlobItem |
Blobinformation från en <xref:BlobServiceClient.findBlobsByTags> |
FilterBlobItemModel |
Blobinformation från ett FILTER Blobs API-anrop |
FilterBlobSegment |
Segmentsvar för <xref:BlobServiceClient.findBlobsByTags> åtgärd. |
FilterBlobSegmentModel |
Resultatet av ett FILTER Blobs API-anrop |
GeoReplication |
Geo-Replication information för den sekundära lagringstjänsten |
HttpAuthorization |
Representerar autentiseringsinformation i Auktorisering, ProxyAuthorization, WWW-Authenticate och Proxy-Authenticate rubrikvärden. |
Lease |
Information om ett specifikt lån. |
LeaseAccessConditions |
Parametergrupp |
LeaseOperationOptions |
Konfigurerar låneåtgärder. |
ListBlobsFlatSegmentResponse |
En uppräkning av blobar |
ListBlobsFlatSegmentResponseModel |
En uppräkning av blobar |
ListBlobsHierarchySegmentResponse |
En uppräkning av blobar |
ListBlobsHierarchySegmentResponseModel |
En uppräkning av blobar |
ListContainersSegmentResponse |
En uppräkning av containrar |
Logging |
Loggningsinställningar för Azure Analytics. |
MatchConditions |
Anger HTTP-alternativ för villkorsstyrda begäranden baserat på ETag-matchning. |
Metadata |
En karta över namn/värde-par som ska associeras med resursen. |
Metrics |
en sammanfattning av begärandestatistik grupperad efter API i tim- eller minutaggregeringar för blobar |
ModificationConditions |
Anger HTTP-alternativ för villkorsstyrda begäranden baserat på ändringstid. |
ModifiedAccessConditions |
villkor för villkorliga HTTP-huvuden och taggar. |
ModifiedAccessConditionsModel |
Parametergrupp |
ObjectReplicationPolicy |
Innehåller princip-ID för objektreplikering och respektive lista över <xref:ObjectReplicationRule>. Detta används när objektreplikeringsegenskaper hämtas på källbloben. Princip-ID:t för målbloben anges i ObjectReplicationDestinationPolicyId för respektive metodsvar (t.ex. <xref:BlobProperties.ObjectReplicationDestinationPolicyId>. |
ObjectReplicationRule |
Innehåller objektreplikeringsregel-ID och <xref:ObjectReplicationStatus> för en blob. Det kan finnas fler än en <xref:ObjectReplicationRule> under en <xref:ObjectReplicationPolicy>. |
PageBlobClearPagesHeaders |
Definierar rubriker för PageBlob_clearPages åtgärd. |
PageBlobClearPagesOptions |
Alternativ för att konfigurera åtgärden <xref:PageBlobClient.clearPages>. |
PageBlobCopyIncrementalHeaders |
Definierar rubriker för PageBlob_copyIncremental åtgärd. |
PageBlobCreateHeaders |
Definierar rubriker för PageBlob_create åtgärd. |
PageBlobCreateIfNotExistsOptions |
Alternativ för att konfigurera åtgärden <xref:PageBlobClient.createIfNotExists>. |
PageBlobCreateIfNotExistsResponse |
Innehåller svarsdata för åtgärden <xref:PageBlobClient.createIfNotExists>. |
PageBlobCreateOptions |
Alternativ för att konfigurera åtgärden <xref:PageBlobClient.create>. |
PageBlobGetPageRangesDiffHeaders |
Definierar rubriker för PageBlob_getPageRangesDiff åtgärd. |
PageBlobGetPageRangesDiffOptions |
Alternativ för att konfigurera åtgärden <xref:PageBlobClient.getRangesDiff>. |
PageBlobGetPageRangesDiffResponse |
Innehåller svarsdata för åtgärden <xref:BlobClient.getPageRangesDiff>. |
PageBlobGetPageRangesHeaders |
Definierar rubriker för PageBlob_getPageRanges åtgärd. |
PageBlobGetPageRangesOptions |
Alternativ för att konfigurera åtgärden <xref:PageBlobClient.getPageRanges>. |
PageBlobGetPageRangesResponse |
Innehåller svarsdata för åtgärden <xref:BlobClient.getPageRanges>. |
PageBlobRequestConditions |
Villkor som ska läggas till i skapandet av den här sidbloben. |
PageBlobResizeHeaders |
Definierar rubriker för PageBlob_resize åtgärd. |
PageBlobResizeOptions |
Alternativ för att konfigurera <xref:PageBlobClient.resize> åtgärd. |
PageBlobStartCopyIncrementalOptions |
Alternativ för att konfigurera <xref:PageBlobClient.startCopyIncremental> åtgärd. |
PageBlobUpdateSequenceNumberHeaders |
Definierar rubriker för PageBlob_updateSequenceNumber åtgärd. |
PageBlobUpdateSequenceNumberOptions |
Alternativ för att konfigurera <xref:PageBlobClient.updateSequenceNumber> åtgärd. |
PageBlobUploadPagesFromURLHeaders |
Definierar rubriker för PageBlob_uploadPagesFromURL åtgärd. |
PageBlobUploadPagesFromURLOptions |
Alternativ för att konfigurera <xref:PageBlobClient.uploadPagesFromURL> åtgärd. |
PageBlobUploadPagesHeaders |
Definierar rubriker för PageBlob_uploadPages åtgärd. |
PageBlobUploadPagesOptions |
Alternativ för att konfigurera åtgärden <xref:PageBlobClient.uploadPages>. |
PageList |
Lista över sidintervall för en blob. |
ParsedBatchResponse |
Multipart-/mixed-svaret som innehåller svaret för varje underbegäran. |
PipelineLike |
Ett gränssnitt för klassen <xref:Pipeline> som innehåller HTTP-begärandeprinciper. Du kan skapa en standardpipeline genom att anropa <xref:newPipeline>. Eller så kan du skapa en pipeline med dina egna principer av konstruktorn för Pipeline. Se <xref:newPipeline> och tillhandahållna principer innan du implementerar din anpassade pipeline. |
PipelineOptions |
Alternativgränssnitt för pipelinekonstruktor. |
Range |
Intervall för Blob Service-åtgärder. |
RetentionPolicy |
kvarhållningsprincipen som avgör hur länge de associerade data ska sparas |
SASQueryParametersOptions |
Alternativ för att konstruera <xref:SASQueryParameters>. |
SasIPRange |
Tillåtna IP-intervall för en SAS. |
SequenceNumberAccessConditions |
Parametergrupp |
ServiceFilterBlobsHeaders |
Definierar rubriker för Service_filterBlobs åtgärd. |
ServiceFindBlobByTagsOptions |
Alternativ för att konfigurera åtgärden <xref:BlobServiceClient.findBlobsByTags>. |
ServiceGenerateAccountSasUrlOptions |
Alternativ för att konfigurera <xref:BlobServiceClient.generateAccountSasUrl> åtgärd. |
ServiceGetAccountInfoHeaders |
Definierar rubriker för Service_getAccountInfo åtgärd. |
ServiceGetAccountInfoOptions |
Alternativ för att konfigurera åtgärden <xref:BlobServiceClient.getAccountInfo>. |
ServiceGetPropertiesHeaders |
Definierar rubriker för Service_getProperties åtgärd. |
ServiceGetPropertiesOptions |
Alternativ för att konfigurera åtgärden <xref:BlobServiceClient.getProperties>. |
ServiceGetStatisticsHeaders |
Definierar rubriker för Service_getStatistics åtgärd. |
ServiceGetStatisticsOptions |
Alternativ för att konfigurera åtgärden <xref:BlobServiceClient.getStatistics>. |
ServiceGetUserDelegationKeyHeaders |
Definierar rubriker för Service_getUserDelegationKey åtgärd. |
ServiceGetUserDelegationKeyOptions |
Alternativ för att konfigurera tjänsten – Hämta användardelegeringsnyckel. |
ServiceListContainersOptions |
Alternativ för att konfigurera åtgärden <xref:BlobServiceClient.listContainers>. |
ServiceListContainersSegmentHeaders |
Definierar rubriker för Service_listContainersSegment åtgärd. |
ServiceRenameContainerOptions |
Alternativ för att konfigurera <xref:BlobServiceClient.renameContainer> åtgärd. |
ServiceSetPropertiesHeaders |
Definierar rubriker för Service_setProperties åtgärd. |
ServiceSetPropertiesOptions |
Alternativ för att konfigurera åtgärden <xref:BlobServiceClient.setProperties>. |
ServiceSubmitBatchHeaders |
Definierar rubriker för Service_submitBatch åtgärd. |
ServiceSubmitBatchOptionalParamsModel |
Valfria parametrar. |
ServiceUndeleteContainerOptions |
Alternativ för att konfigurera <xref:BlobServiceClient.undeleteContainer> åtgärd. |
SignedIdentifier |
Signerad identifierare. |
SignedIdentifierModel |
signerad identifierare |
StaticWebsite |
De egenskaper som gör det möjligt för ett konto att vara värd för en statisk webbplats |
StorageClientOptionalParams |
Valfria parametrar. |
StoragePipelineOptions |
Alternativgränssnitt för funktionen <xref:newPipeline>. |
StorageRetryOptions |
Alternativ för återförsök av lagringsblob. |
TagConditions |
Anger HTTP-alternativ för villkorsstyrda begäranden baserat på blobtaggar. |
UserDelegationKey |
En användardelegeringsnyckel. |
UserDelegationKeyModel |
En nyckel för användardelegering |
Typalias
AccessTier |
Definierar värden för AccessTier. |
AccountKind |
Definierar värden för AccountKind. |
AppendBlobAppendBlockFromUrlResponse |
Innehåller svarsdata för åtgärden appendBlockFromUrl. |
AppendBlobAppendBlockResponse |
Innehåller svarsdata för åtgärden appendBlock. |
AppendBlobCreateResponse |
Innehåller svarsdata för skapandeåtgärden. |
ArchiveStatus |
Definierar värden för ArchiveStatus. |
BlobAbortCopyFromURLResponse |
Innehåller svarsdata för åtgärden abortCopyFromURL. |
BlobBatchDeleteBlobsResponse |
Innehåller svarsdata för åtgärden <xref:deleteBlobs>. |
BlobBatchSetBlobsAccessTierResponse |
Innehåller svarsdata för åtgärden <xref:setBlobsAccessTier>. |
BlobBatchSubmitBatchResponse |
Innehåller svarsdata för blobbatchåtgärder. |
BlobCopyFromURLResponse |
Innehåller svarsdata för åtgärden copyFromURL. |
BlobCreateSnapshotResponse |
Innehåller svarsdata för åtgärden createSnapshot. |
BlobDeleteImmutabilityPolicyResponse |
Innehåller svarsdata för åtgärden deleteImmutabilityPolicy. |
BlobDeleteResponse |
Innehåller svarsdata för borttagningsåtgärden. |
BlobDownloadResponseModel |
Innehåller svarsdata för nedladdningsåtgärden. |
BlobGetPropertiesResponseModel |
Innehåller svarsdata för åtgärden getProperties. |
BlobGetTagsResponse |
Innehåller svarsdata för åtgärden <xref:BlobClient.getTags>. |
BlobImmutabilityPolicyMode |
Definierar värden för BlobImmutabilityPolicyMode. |
BlobQueryArrowFieldType |
Typen av en <xref:BlobQueryArrowField>. |
BlobQueryResponseModel |
Innehåller svarsdata för frågeåtgärden. |
BlobSetHTTPHeadersResponse |
Innehåller svarsdata för setHttpHeaders-åtgärden. |
BlobSetImmutabilityPolicyResponse |
Innehåller svarsdata för åtgärden setImmutabilityPolicy. |
BlobSetLegalHoldResponse |
Innehåller svarsdata för setLegalHold-åtgärden. |
BlobSetMetadataResponse |
Innehåller svarsdata för setMetadata-åtgärden. |
BlobSetTagsResponse |
Innehåller svarsdata för setTags-åtgärden. |
BlobSetTierResponse |
Innehåller svarsdata för setTier-åtgärden. |
BlobStartCopyFromURLResponse |
Innehåller svarsdata för åtgärden startCopyFromURL. |
BlobType |
Definierar värden för BlobType. |
BlobUndeleteResponse |
Innehåller svarsdata för åtgärden för att ta bort borttagningen. |
BlobUploadCommonResponse |
Svarstyp för <xref:BlockBlobClient.uploadFile>, <xref:BlockBlobClient.uploadStream>och <xref:BlockBlobClient.uploadBrowserDate>. |
BlockBlobCommitBlockListResponse |
Innehåller svarsdata för commitBlockList-åtgärden. |
BlockBlobGetBlockListResponse |
Innehåller svarsdata för åtgärden getBlockList. |
BlockBlobPutBlobFromUrlResponse |
Innehåller svarsdata för putBlobFromUrl-åtgärden. |
BlockBlobStageBlockFromURLResponse |
Innehåller svarsdata för stageBlockFromURL-åtgärden. |
BlockBlobStageBlockResponse |
Innehåller svarsdata för stageBlock-åtgärden. |
BlockBlobUploadResponse |
Innehåller svarsdata för uppladdningsåtgärden. |
BlockListType |
Definierar värden för BlockListType. |
ContainerCreateResponse |
Innehåller svarsdata för skapandeåtgärden. |
ContainerDeleteResponse |
Innehåller svarsdata för borttagningsåtgärden. |
ContainerGetAccessPolicyResponse |
Innehåller svarsdata för åtgärden <xref:ContainerClient.getAccessPolicy>. |
ContainerGetPropertiesResponse |
Innehåller svarsdata för åtgärden getProperties. |
ContainerListBlobFlatSegmentResponse |
Innehåller svarsdata för åtgärden listBlobFlatSegment. |
ContainerListBlobHierarchySegmentResponse |
Innehåller svarsdata för åtgärden listBlobHierarchySegment. |
ContainerRenameResponse |
Innehåller svarsdata för åtgärden byt namn. |
ContainerSetAccessPolicyResponse |
Innehåller svarsdata för setAccessPolicy-åtgärden. |
ContainerSetMetadataResponse |
Innehåller svarsdata för setMetadata-åtgärden. |
ContainerUndeleteResponse |
Innehåller svarsdata för återställningsåtgärden. |
CopyPollerBlobClient |
Definierar åtgärderna från en <xref:BlobClient> som behövs för att polleraren som returneras av <xref:BlobClient.beginCopyFromURL> ska fungera. |
CopyStatusType |
Definierar värden för CopyStatusType. |
CredentialPolicyCreator |
En fabriksfunktion som skapar en ny CredentialPolicy som använder den angivna nextPolicy. |
DeleteSnapshotsOptionType |
Definierar värden för DeleteSnapshotsOptionType. |
EncryptionAlgorithmType |
Definierar värden för EncryptionAlgorithmType. |
GeoReplicationStatusType |
Definierar värden för GeoReplicationStatusType. |
LeaseDurationType |
Definierar värden för LeaseDurationType. |
LeaseOperationResponse |
Innehåller svarsdata för åtgärder som skapar, ändrar eller tar bort ett lån. Se <xref:BlobLeaseClient>. |
LeaseStateType |
Definierar värden för LeaseStateType. |
LeaseStatusType |
Definierar värden för LeaseStatusType. |
ListBlobsIncludeItem |
Definierar värden för ListBlobsIncludeItem. |
ListContainersIncludeType |
Definierar värden för ListContainersIncludeType. |
ObjectReplicationStatus |
Anger replikeringsstatus för en blob. Detta används när ett lagringskonto har tillämpat principer för objektreplikering. Se <xref:ObjectReplicationPolicy> och <xref:ObjectReplicationRule>. |
PageBlobClearPagesResponse |
Innehåller svarsdata för åtgärden clearPages. |
PageBlobCopyIncrementalResponse |
Innehåller svarsdata för åtgärden copyIncremental. |
PageBlobCreateResponse |
Innehåller svarsdata för skapandeåtgärden. |
PageBlobResizeResponse |
Innehåller svarsdata för storleksändringsåtgärden. |
PageBlobUpdateSequenceNumberResponse |
Innehåller svarsdata för åtgärden updateSequenceNumber. |
PageBlobUploadPagesFromURLResponse |
Innehåller svarsdata för åtgärden uploadPagesFromURL. |
PageBlobUploadPagesResponse |
Innehåller svarsdata för åtgärden uploadPages. |
PublicAccessType |
Definierar värden för PublicAccessType. |
RehydratePriority |
Definierar värden för RehydratePriority. |
SequenceNumberActionType |
Definierar värden för SequenceNumberActionType. |
ServiceFindBlobsByTagsSegmentResponse |
Svaret från <xref:BlobServiceClient.findBlobsByTags> åtgärd. |
ServiceGetAccountInfoResponse |
Innehåller svarsdata för åtgärden getAccountInfo. |
ServiceGetPropertiesResponse |
Innehåller svarsdata för åtgärden getProperties. |
ServiceGetStatisticsResponse |
Innehåller svarsdata för åtgärden getStatistics. |
ServiceGetUserDelegationKeyResponse |
Innehåller svarsdata för åtgärden <xref:getUserDelegationKey>. |
ServiceListContainersSegmentResponse |
Innehåller svarsdata för åtgärden listContainersSegment. |
ServiceSetPropertiesResponse |
Innehåller svarsdata för åtgärden setProperties. |
ServiceSubmitBatchResponseModel |
Innehåller svarsdata för åtgärden submitBatch. |
SkuName |
Definierar värden för SkuName. |
SyncCopyStatusType |
Definierar värden för SyncCopyStatusType. |
Tags |
Blobtaggar. |
Uppräkningar
BlockBlobTier |
Representerar åtkomstnivån på en blob. Detaljerad information om blockblobnivånivåer finns i lagringsnivåer för frekvent, lågfrekvent lagring och arkivlagring. |
PremiumPageBlobTier |
Anger den sidblobnivå som bloben ska anges till. Detta gäller endast sidblobbar på Premium Storage-konton. Se här för detaljerad information om motsvarande IOPS och dataflöde per PageBlobTier. |
SASProtocol |
Protokoll för genererad SAS. |
StorageRetryPolicyType |
RetryPolicy-typer. |
Funktioner
generate |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Genererar ett <xref:SASQueryParameters> objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran. |
generate |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en instans av SASQueryParameters. Accepterar endast nödvändiga inställningar som krävs för att skapa en SAS. För valfria inställningar anger du motsvarande egenskaper direkt, till exempel behörigheter, startsOn och identifierare. VARNING! När identifieraren inte har angetts krävs behörigheter och expiresOn. Du MÅSTE tilldela värdet till identifieraren eller förfallerPå & behörigheter manuellt om du börjar med den här konstruktorn. Fyll i nödvändig information innan du kör följande kodfragment. Exempel på användning:
Exempel med en identifierare:
Exempel med ett blobnamn:
|
generate |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en instans av SASQueryParameters. VARNING! Identifieraren ignoreras när sas för användardelegering genereras, behörigheter och upphör att gällaPå krävs. Exempel på användning:
|
is |
En hjälp för att avgöra om ett visst argument uppfyller pipelinekontraktet |
new |
Skapar ett nytt pipelineobjekt med angivna autentiseringsuppgifter. |
Funktionsinformation
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Genererar ett <xref:SASQueryParameters> objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran.
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
Parametrar
- accountSASSignatureValues
- AccountSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Returer
generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en instans av SASQueryParameters.
Accepterar endast nödvändiga inställningar som krävs för att skapa en SAS. För valfria inställningar anger du motsvarande egenskaper direkt, till exempel behörigheter, startsOn och identifierare.
VARNING! När identifieraren inte har angetts krävs behörigheter och expiresOn. Du MÅSTE tilldela värdet till identifieraren eller förfallerPå & behörigheter manuellt om du börjar med den här konstruktorn.
Fyll i nödvändig information innan du kör följande kodfragment.
Exempel på användning:
// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
containerName, // Required
permissions: ContainerSASPermissions.parse("racwdl"), // Required
startsOn: new Date(), // Optional
expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
protocol: SASProtocol.HttpsAndHttp, // Optional
version: "2016-05-31" // Optional
},
sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
Exempel med en identifierare:
// Generate service level SAS for a container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
{
accessPolicy: {
expiresOn: new Date(new Date().valueOf() + 86400), // Date type
permissions: ContainerSASPermissions.parse("racwdl").toString(),
startsOn: new Date() // Date type
},
id: identifier
}
]);
const containerSAS = generateBlobSASQueryParameters(
{
containerName, // Required
identifier // Required
},
sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
Exempel med ett blobnamn:
// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
containerName, // Required
blobName, // Required
permissions: BlobSASPermissions.parse("racwd"), // Required
startsOn: new Date(), // Optional
expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
cacheControl: "cache-control-override", // Optional
contentDisposition: "content-disposition-override", // Optional
contentEncoding: "content-encoding-override", // Optional
contentLanguage: "content-language-override", // Optional
contentType: "content-type-override", // Optional
ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
protocol: SASProtocol.HttpsAndHttp, // Optional
version: "2016-05-31" // Optional
},
sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
Parametrar
- blobSASSignatureValues
- BlobSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Returer
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en instans av SASQueryParameters. VARNING! Identifieraren ignoreras när sas för användardelegering genereras, behörigheter och upphör att gällaPå krävs.
Exempel på användning:
// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
containerName, // Required
permissions: ContainerSASPermissions.parse("racwdl"), // Required
startsOn, // Optional. Date type
expiresOn, // Required. Date type
ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
protocol: SASProtocol.HttpsAndHttp, // Optional
version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
},
userDelegationKey, // UserDelegationKey
accountName
).toString();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string)
Parametrar
- blobSASSignatureValues
- BlobSASSignatureValues
- userDelegationKey
- UserDelegationKey
Returvärde för blobServiceClient.getUserDelegationKey()
- accountName
-
string
Returer
isPipelineLike(unknown)
En hjälp för att avgöra om ett visst argument uppfyller pipelinekontraktet
function isPipelineLike(pipeline: unknown)
Parametrar
- pipeline
-
unknown
Ett argument som kan vara en pipeline
Returer
boolean
sant när argumentet uppfyller pipelinekontraktet
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Skapar ett nytt pipelineobjekt med angivna autentiseringsuppgifter.
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions)
Parametrar
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från @azure/identity
-paketet för att autentisera begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.
- pipelineOptions
- StoragePipelineOptions
Valfri. Alternativ.
Returer
Ett nytt pipelineobjekt.
Azure SDK for JavaScript