Sdílet prostřednictvím


@azure/storage-file package

Třídy

Aborter

Instance aborter implementuje rozhraní AbortSignal, může přerušit požadavky HTTP.

  • VoláníM metody Aborter.none vytvořte novou instanci Aborter bez časového limitu.
  • Zavolejte Aborter.timeout() a vytvořte novou instanci Aborter s vypršením časového limitu.

Pro existující instanci přerušte:

  • Voláním metody aborter.withTimeout() vytvořte a vraťte podřízenou instanci Aborter s vypršením časového limitu.
  • Volání aborter.withValue(key, value) k vytvoření a vrácení podřízené instance Aborter s párem klíč/hodnota.
  • Voláním metody aborter.abort() přerušíte aktuální instanci a všechny podřízené instance.
  • Volání aborter.getValue(key) pro vyhledávání a získání hodnoty s odpovídajícím klíčem od aktuálního přerušení do všech nadřazených objektů.
AccountSASPermissions

K DISPOZICI POUZE V NODE.JS RUNTIME. Toto je pomocná třída pro vytvoření řetězce představujícího oprávnění udělená účtem AccountSAS. Nastavení hodnoty true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole oprávnění u objektu <xref:IAccountSASSignatureValues>. Řetězec oprávnění je možné vytvořit bez této třídy, ale pořadí oprávnění je specifické a tato třída zaručuje správnost.

AccountSASResourceTypes

K DISPOZICI POUZE V NODE.JS RUNTIME. Jedná se o pomocnou třídu pro vytvoření řetězce představujícího prostředky přístupné účtem AccountSAS. Nastavení hodnoty na hodnotu true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí přístup k danému typu prostředku. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole prostředků v objektu <xref:IAccountSASSignatureValues>. Řetězec prostředků je možné sestavit bez této třídy, ale pořadí prostředků je specifické a tato třída zaručuje správnost.

AccountSASServices

K DISPOZICI POUZE V NODE.JS RUNTIME. Toto je pomocná třída pro vytvoření řetězce představující služby přístupné účtem AccountSAS. Nastavení hodnoty true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí přístup k této službě. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole služeb v objektu <xref:IAccountSASSignatureValues>. Řetězec služeb je možné sestavit bez této třídy, ale pořadí služeb je specifické a tato třída zaručuje správnost.

BrowserPolicyFactory

BrowserPolicyFactory je třída továrny, která pomáhá generovat objekty BrowserPolicy.

DirectoryURL

A DirectoryURL představuje adresu URL adresáře služby Azure Storage, který umožňuje manipulovat s jeho soubory a adresáři.

FileSASPermissions

K DISPOZICI POUZE V NODE.JS RUNTIME. Toto je pomocná třída pro vytvoření řetězce představujícího oprávnění udělená službou ServiceSAS k souboru. Nastavení hodnoty true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole oprávnění u <xref:IFileSASSignatureValues> objektu. Řetězec oprávnění je možné vytvořit bez této třídy, ale pořadí oprávnění je specifické a tato třída zaručuje správnost.

FileSystemAttributes

Toto je pomocná třída pro vytvoření řetězce představujícího atributy NTFS do souboru nebo adresáře.

FileURL

A FileURL představuje adresu URL k souboru Azure Storage.

KeepAlivePolicyFactory

KeepAlivePolicyFactory je třída továrny, která pomáhá generovat objekty KeepAlivePolicy.

LoggingPolicyFactory

LoggingPolicyFactory je třída továrny, která pomáhá generovat objekty LoggingPolicy.

Pipeline

Třída kanálu obsahující zásady požadavků HTTP. Výchozí kanál můžete vytvořit voláním StorageURL.newPipeline(). Nebo můžete vytvořit kanál s vlastními zásadami konstruktorem kanálu. Před implementací přizpůsobeného kanálu se podívejte na StorageURL.newPipeline() a před implementací přizpůsobeného kanálu uveďte zásady jako referenci.

RetryPolicyFactory

RetryPolicyFactory je třída továrny, která pomáhá generovat objekty RetryPolicy.

SASQueryParameters

Představuje komponenty, které tvoří parametry dotazu SAS služby Azure Storage. Tento typ není vytvořen přímo uživatelem; generuje se pouze typy <xref:IAccountSASSignatureValues> a <xref:IFileSASSignatureValues>. Po vygenerování je možné ho zakódovat do řetězce {@code String} a připojit přímo k adrese URL (v případě, že existují existující parametry dotazu, které by mohly ovlivnit vhodné prostředky připojení těchto parametrů dotazu). POZNÁMKA: Instance této třídy jsou neměnné.

ServiceURL

Služba ServiceURL představuje adresu URL služby Azure Storage File, která umožňuje manipulovat se sdílenými složkami.

ShareSASPermissions

Toto je pomocná třída pro vytvoření řetězce představujícího oprávnění udělená službou ServiceSAS ke sdílené složce. Nastavení hodnoty true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole oprávnění u <xref:IFileSASSignatureValues> objektu. Řetězec oprávnění je možné vytvořit bez této třídy, ale pořadí oprávnění je specifické a tato třída zaručuje správnost.

ShareURL

ShareURL představuje adresu URL sdílené složky Azure Storage, která umožňuje manipulovat s jeho adresáři a soubory.

StorageURL

A ServiceURL představuje založenou třídu URL pro ServiceURL, ContainerURL a atd.

TelemetryPolicyFactory

TelemetryPolicyFactory je třída továrny, která pomáhá generovat objekty TelemetryPolicy.

UniqueRequestIDPolicyFactory

UniqueRequestIDPolicyFactory je třída továrny, která pomáhá generovat objekty UniqueRequestIDPolicy.

AnonymousCredential

AnonymousCredential poskytuje člen credentialPolicyCreator sloužící k vytvoření AnonymousCredentialPolicy objekty. AnonymousCredentialPolicy se používá s požadavky HTTP(S), které čtou veřejné prostředky nebo se používají se sdílenými přístupovými podpisy (SAS).

Credential

Přihlašovací údaje jsou abstraktní třídou pro podepisování požadavků HTTP služby Azure Storage. Tato třída bude hostitelem objektu pro vytváření přihlašovacích údajůPolicyCreator, který generuje CredentialPolicy.

SharedKeyCredential

K DISPOZICI POUZE V NODE.JS RUNTIME. SharedKeyCredential pro autorizaci klíče účtu služby Azure Storage.

Directory

Třída představující adresář

File

Třída představující soubor

Service

Třída představující službu

Share

Třída představující sdílenou složku

StorageClient
StorageClientContext
AnonymousCredentialPolicy

AnonymousCredentialPolicy se používá s požadavky HTTP(S), které čtou veřejné prostředky nebo se používají se sdílenými přístupovými podpisy (SAS).

BrowserPolicy

BrowserPolicy bude zpracovávat rozdíly mezi Node.js a modulem runtime prohlížeče, včetně:

  1. Prohlížeče ukládají požadavky GET/HEAD do mezipaměti přidáním podmíněných hlaviček, jako je například IF_MODIFIED_SINCE. BrowserPolicy je zásada použitá k přidání dotazu časového razítka na adresu URL požadavku GET/HEAD, čímž se vyhnete mezipaměti prohlížeče.

  2. Odebrání hlavičky cookie pro zabezpečení

  3. Odebrání záhlaví délky obsahu, aby se zabránilo upozornění prohlížečů

CredentialPolicy

Zásady přihlašovacích údajů používané k podepsání požadavků HTTP(S) před odesláním Toto je abstraktní třída.

KeepAlivePolicy

KeepAlivePolicy je zásada, která slouží k řízení nastavení zachování aktivního života pro každou žádost.

LoggingPolicy

LoggingPolicy je zásada používaná k protokolování požadavků.

RetryPolicy

Zásady opakování s exponenciálními opakováními a implementovanými lineárními opakováními

SharedKeyCredentialPolicy

SharedKeyCredentialPolicy je zásada použitá k podepsání požadavku HTTP pomocí sdíleného klíče.

TelemetryPolicy

TelemetryPolicy je zásada použitá k označení hlavičky uživatelského agenta pro všechny požadavky.

UniqueRequestIDPolicy

UniqueRequestIDPolicy vygeneruje UUID jako hodnotu hlavičky x-ms-request-id.

Batch

Služba Batch poskytuje základní paralelní spouštění s omezeními souběžnosti. Zastaví provádění levých operací, když jedna z prováděných operací vyvolá chybu. Služba Batch ale nemůže zrušit probíhající operace, musíte je zrušit sami.

BufferScheduler

Tato třída přijímá Node.js readable stream jako vstup a udržuje čtení dat z datového proudu do interní vyrovnávací struktury, dokud nedosáhne maxBuffers. Každá dostupná vyrovnávací paměť se pokusí aktivovat odchozí obslužnou rutinu. Struktura interní vyrovnávací paměti obsahuje pole příchozí vyrovnávací paměti a pole odchozí vyrovnávací paměti. Pole příchozí vyrovnávací paměti obsahuje prázdné vyrovnávací paměti, které lze vyplnit novými příchozími daty. Odchozí pole obsahuje vyplněné vyrovnávací paměti, které se mají zpracovat pomocí odchozí obslužné rutiny. Každá výše uvedená velikost vyrovnávací paměti je definována vyrovnávací pamětí parametruSize.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

<NUM_OF_ALL_BUFFERS = maxBuffers

TIPY KE ZLEPŠENÍ VÝKONU:

  1. Vstupní datový proud highWaterMark je lepší nastavit stejnou hodnotu s parametrem bufferSize, což zabrání operacím Buffer.concat().
  2. Paralelismus by měl nastavit menší hodnotu než maxBuffers, což je užitečné, když odchozí obslužná rutina čeká na data datového proudu. v této situaci jsou odchozí obslužné rutiny blokované. Odchozí fronta by neměla být prázdná.
RetriableReadableStream

K DISPOZICI POUZE V NODE.JS RUNTIME. Node.js ReadableStream se bude interně opakovat, když interní ReadableStream neočekávaně skončí.

Rozhraní

IDirectoryCreateOptions
IDirectoryForceCloseHandlesSegmentOptions
IDirectoryListFilesAndDirectoriesSegmentOptions
IDirectoryListHandlesSegmentOptions
IDirectoryProperties
IFileCreateOptions
IFileDownloadOptions
IFileGetRangeListOptions

Možnost je definována jako parita pro definici REST. I když není připravený k použití, vzhledem k tomu, že Crc64 zdrojového obsahu není přístupný.

IFileListHandlesSegmentOptions
IFileProperties
IFileStartCopyOptions
IFileUploadRangeOptions
ISetPropertiesResponse
IAccountSASSignatureValues

K DISPOZICI POUZE V NODE.JS RUNTIME. IAccountSASSignatureValues slouží k vygenerování sdíleného přístupového podpisu (SAS) pro účet služby Azure Storage. Jakmile jsou všechny zde uvedené hodnoty správně nastaveny, volání generateSASQueryParameters() získat reprezentaci SAS, které lze skutečně použít na adresy URL souborů. Poznámka: Tato třída i <xref:SASQueryParameters> existují, protože první třída je proměnlivá a logická reprezentace, zatímco druhá třída je neměnná a používá se k vygenerování skutečných požadavků REST.

IFileSASSignatureValues

K DISPOZICI POUZE V NODE.JS RUNTIME. IFileSASSignatureValues slouží ke generování tokenů SAS souborové služby pro sdílené složky nebo soubory.

IIPRange

Povolený rozsah IP adres pro SAS.

IRange

Rozsah operací služby.

IKeepAliveOptions

Rozhraní Možnosti KeepAlivePolicy.

IRequestLogOptions

RequestLogOptions konfiguruje chování zásad opakování.

IPipelineOptions

Rozhraní option pro konstruktor kanálu.

IRetryOptions

Rozhraní možností opakování

IServiceListSharesSegmentOptions
IShareCreateOptions
IShareCreateSnapshotOptions
IShareDeleteMethodOptions
ISignedIdentifier
INewPipelineOptions

Rozhraní option pro metodu Pipeline.newPipeline.

ITelemetryOptions

Rozhraní možností TelemetryPolicy

AccessPolicy

Zásady přístupu.

CorsRule

CORS je funkce HTTP, která umožňuje webové aplikaci spuštěné v jedné doméně přistupovat k prostředkům v jiné doméně. Webové prohlížeče implementují omezení zabezpečení známé jako zásady stejného původu, které brání webové stránce v volání rozhraní API v jiné doméně; CORS poskytuje bezpečný způsob, jak povolit, aby jedna doména (původní doména) volala rozhraní API v jiné doméně.

DirectoryCreateHeaders

Definuje hlavičky pro operaci Vytvoření.

DirectoryCreateOptionalParams

Volitelné parametry.

DirectoryDeleteHeaders

Definuje hlavičky pro operaci Delete.

DirectoryDeleteMethodOptionalParams

Volitelné parametry.

DirectoryForceCloseHandlesHeaders

Definuje hlavičky pro operaci ForceCloseHandles.

DirectoryForceCloseHandlesOptionalParams

Volitelné parametry.

DirectoryGetPropertiesHeaders

Definuje hlavičky pro operaci GetProperties.

DirectoryGetPropertiesOptionalParams

Volitelné parametry.

DirectoryItem

Položka adresáře uvedená v seznamu.

DirectoryListFilesAndDirectoriesSegmentHeaders

Definuje hlavičky pro operaci ListFilesAndDirectoriesSegment.

DirectoryListFilesAndDirectoriesSegmentOptionalParams

Volitelné parametry.

DirectoryListHandlesHeaders

Definuje hlavičky pro operaci ListHandles.

DirectoryListHandlesOptionalParams

Volitelné parametry.

DirectorySetMetadataHeaders

Definuje hlavičky pro operaci SetMetadata.

DirectorySetMetadataOptionalParams

Volitelné parametry.

DirectorySetPropertiesHeaders

Definuje hlavičky pro operaci SetProperties.

DirectorySetPropertiesOptionalParams

Volitelné parametry.

FileAbortCopyHeaders

Definuje hlavičky pro operaci AbortCopy.

FileAbortCopyOptionalParams

Volitelné parametry.

FileCreateHeaders

Definuje hlavičky pro operaci Vytvoření.

FileCreateOptionalParams

Volitelné parametry.

FileDeleteHeaders

Definuje hlavičky pro operaci Delete.

FileDeleteMethodOptionalParams

Volitelné parametry.

FileDownloadHeaders

Definuje hlavičky pro operaci Stažení.

FileDownloadOptionalParams

Volitelné parametry.

FileForceCloseHandlesHeaders

Definuje hlavičky pro operaci ForceCloseHandles.

FileForceCloseHandlesOptionalParams

Volitelné parametry.

FileGetPropertiesHeaders

Definuje hlavičky pro operaci GetProperties.

FileGetPropertiesOptionalParams

Volitelné parametry.

FileGetRangeListHeaders

Definuje hlavičky pro operaci GetRangeList.

FileGetRangeListOptionalParams

Volitelné parametry.

FileHTTPHeaders

Další parametry pro sadu operací, například: File_create, File_setHTTPHeaders.

FileItem

Položka souboru v seznamu.

FileListHandlesHeaders

Definuje hlavičky pro operaci ListHandles.

FileListHandlesOptionalParams

Volitelné parametry.

FileProperty

Vlastnosti souboru.

FileSetHTTPHeadersHeaders

Definuje hlavičky pro operaci SetHTTPHeaders.

FileSetHTTPHeadersOptionalParams

Volitelné parametry.

FileSetMetadataHeaders

Definuje hlavičky pro operaci SetMetadata.

FileSetMetadataOptionalParams

Volitelné parametry.

FileStartCopyHeaders

Definuje hlavičky pro operaci StartCopy.

FileStartCopyOptionalParams

Volitelné parametry.

FileUploadRangeFromURLHeaders

Definuje hlavičky pro operaci UploadRangeFromURL.

FileUploadRangeFromURLOptionalParams

Volitelné parametry.

FileUploadRangeHeaders

Definuje hlavičky pro operaci UploadRange.

FileUploadRangeOptionalParams

Volitelné parametry.

FilesAndDirectoriesListSegment

Abstrakce pro položky, které lze uvést z adresáře.

HandleItem

Položka popisovače služby Azure Storage uvedená v seznamu

ListFilesAndDirectoriesSegmentResponse

Výčet adresářů a souborů.

ListHandlesResponse

Výčet popisovačů

ListSharesResponse

Výčet sdílených složek.

Metrics

Metriky Analýzy úložiště pro souborovou službu

Permission

Oprávnění (popisovač zabezpečení) popsaný v jazyce SDDL (Security Descriptor Definition Language).

Range

Rozsah souborů Azure Storage.

RetentionPolicy

Zásady uchovávání informací.

ServiceGetPropertiesHeaders

Definuje hlavičky pro operaci GetProperties.

ServiceGetPropertiesOptionalParams

Volitelné parametry.

ServiceListSharesSegmentHeaders

Definuje hlavičky pro operaci ListSharesSegment.

ServiceListSharesSegmentOptionalParams

Volitelné parametry.

ServiceSetPropertiesHeaders

Definuje hlavičky pro operaci SetProperties.

ServiceSetPropertiesOptionalParams

Volitelné parametry.

ShareCreateHeaders

Definuje hlavičky pro operaci Vytvoření.

ShareCreateOptionalParams

Volitelné parametry.

ShareCreatePermissionHeaders

Definuje hlavičky pro operaci CreatePermission.

ShareCreatePermissionOptionalParams

Volitelné parametry.

ShareCreateSnapshotHeaders

Definuje hlavičky pro operaci CreateSnapshot.

ShareCreateSnapshotOptionalParams

Volitelné parametry.

ShareDeleteHeaders

Definuje hlavičky pro operaci Delete.

ShareDeleteMethodOptionalParams

Volitelné parametry.

ShareGetAccessPolicyHeaders

Definuje hlavičky pro operaci GetAccessPolicy.

ShareGetAccessPolicyOptionalParams

Volitelné parametry.

ShareGetPermissionHeaders

Definuje hlavičky pro operaci GetPermission.

ShareGetPermissionOptionalParams

Volitelné parametry.

ShareGetPropertiesHeaders

Definuje hlavičky pro operaci GetProperties.

ShareGetPropertiesOptionalParams

Volitelné parametry.

ShareGetStatisticsHeaders

Definuje hlavičky pro operaci GetStatistics.

ShareGetStatisticsOptionalParams

Volitelné parametry.

ShareItem

Uvedená položka sdílené složky Azure Storage.

ShareProperties

Vlastnosti sdílené složky

ShareSetAccessPolicyHeaders

Definuje hlavičky pro operaci SetAccessPolicy.

ShareSetAccessPolicyOptionalParams

Volitelné parametry.

ShareSetMetadataHeaders

Definuje hlavičky pro operaci SetMetadata.

ShareSetMetadataOptionalParams

Volitelné parametry.

ShareSetQuotaHeaders

Definuje hlavičky pro operaci SetQuota.

ShareSetQuotaOptionalParams

Volitelné parametry.

ShareStats

Statistiky sdílené složky

SignedIdentifier

Podepsaný identifikátor.

SourceModifiedAccessConditions

Další parametry pro operaci uploadRangeFromURL

StorageError

Rozhraní představující chybu StorageError.

StorageServiceProperties

Vlastnosti služby Úložiště

IDownloadFromAzureFileOptions

Rozhraní možností pro DownloadAzurefileToBuffer.

IUploadToAzureFileOptions

Rozhraní možností pro uploadFileToAzureFile a uploadSeekableStreamToAzureFile.

IUploadStreamToAzureFileOptions

Rozhraní option pro uploadStreamToAzureFile.

IFileAndDirectoryCreateCommonOptions
IFileAndDirectorySetPropertiesCommonOptions
IFileHTTPHeaders
IMetadata
IRetriableReadableStreamOptions

Aliasy typu

FileDownloadResponse

Obsahuje data odpovědí pro operaci stahování.

FileGetRangeListResponse

Obsahuje data odpovědi pro operaci getRangeList.

ShareGetAccessPolicyResponse

Obsahuje data odpovědí pro operaci getAccessPolicy.

ShareGetStatisticsResponse

Obsahuje data odpovědi pro operaci getStatistics.

CredentialPolicyCreator

Funkce továrny, která vytvoří novou credentialPolicy, která používá zadanou zásadu nextPolicy.

CopyStatusType

Definuje hodnoty pro CopyStatusType. Mezi možné hodnoty patří: "pending", 'success', 'aborted', 'failed'

DeleteSnapshotsOptionType

Definuje hodnoty pro DeleteSnapshotsOptionType. Mezi možné hodnoty patří: include

DirectoryCreateResponse

Obsahuje data odpovědí pro operaci vytvoření.

DirectoryDeleteResponse

Obsahuje data odpovědi pro operaci deleteMethod.

DirectoryForceCloseHandlesResponse

Obsahuje data odpovědi pro operaci forceCloseHandles.

DirectoryGetPropertiesResponse

Obsahuje data odpovědí pro operaci getProperties.

DirectoryListFilesAndDirectoriesSegmentResponse

Obsahuje data odpovědi pro operaci listFilesAndDirectoriesSegment.

DirectoryListHandlesResponse

Obsahuje data odpovědi pro operaci listHandles.

DirectorySetMetadataResponse

Obsahuje data odpovědi pro operaci setMetadata.

DirectorySetPropertiesResponse

Obsahuje data odpovědi pro operaci setProperties.

FileAbortCopyResponse

Obsahuje data odpovědí pro operaci abortCopy.

FileCreateResponse

Obsahuje data odpovědí pro operaci vytvoření.

FileDeleteResponse

Obsahuje data odpovědi pro operaci deleteMethod.

FileForceCloseHandlesResponse

Obsahuje data odpovědi pro operaci forceCloseHandles.

FileGetPropertiesResponse

Obsahuje data odpovědí pro operaci getProperties.

FileListHandlesResponse

Obsahuje data odpovědi pro operaci listHandles.

FileRangeWriteType

Definuje hodnoty pro FileRangeWriteType. Mezi možné hodnoty patří: "update", "clear"

FileSetHTTPHeadersResponse

Obsahuje data odpovědí pro operaci setHTTPHeaders.

FileSetMetadataResponse

Obsahuje data odpovědi pro operaci setMetadata.

FileStartCopyResponse

Obsahuje data odpovědí pro operaci startCopy.

FileType

Definuje hodnoty pro FileType. Mezi možné hodnoty patří: File

FileUploadRangeFromURLResponse

Obsahuje data odpovědi pro operaci uploadRangeFromURL.

FileUploadRangeResponse

Obsahuje data odpovědí pro operaci uploadRange.

ListSharesIncludeType

Definuje hodnoty pro ListSharesIncludeType. Mezi možné hodnoty patří: "snapshots", "metadata"

ServiceGetPropertiesResponse

Obsahuje data odpovědí pro operaci getProperties.

ServiceListSharesSegmentResponse

Obsahuje data odpovědí pro operaci listSharesSegment.

ServiceSetPropertiesResponse

Obsahuje data odpovědi pro operaci setProperties.

ShareCreatePermissionResponse

Obsahuje data odpovědí pro operaci createPermission.

ShareCreateResponse

Obsahuje data odpovědí pro operaci vytvoření.

ShareCreateSnapshotResponse

Obsahuje data odpovědí pro operaci createSnapshot.

ShareDeleteResponse

Obsahuje data odpovědi pro operaci deleteMethod.

ShareGetPermissionResponse

Obsahuje data odpovědi pro operaci getPermission.

ShareGetPropertiesResponse

Obsahuje data odpovědí pro operaci getProperties.

ShareSetAccessPolicyResponse

Obsahuje data odpovědi pro operaci setAccessPolicy.

ShareSetMetadataResponse

Obsahuje data odpovědi pro operaci setMetadata.

ShareSetQuotaResponse

Obsahuje data odpovědi pro operaci setQuota.

StorageErrorCode

Definuje hodnoty pro StorageErrorCode. Mezi možné hodnoty patří: AccountAlreadyExists, AccountBeingCreated, AccountIsDisabled, AuthenticationFailed, AuthorizationFailure, ConditionHeadersNotSupported, ConditionNotMet, EmptyMetadataKey, InsufficientAccountPermissions, InternalError, InvalidAuthenticationInfo, InvalidHeaderValue, InvalidHttpVerb, InvalidInput, InvalidMd5, InvalidMetadata, InvalidQueryParameterValue, InvalidRange, InvalidResourceName, InvalidUri, InvalidXmlDocument, InvalidXmlNodeValue, Md5Mismatch, MetadataTooLarge, MissingContentLengthHeader, MissingRequiredQueryParameter, MissingRequiredHeader, MissingRequiredXmlNode, MultipleConditionHeadersNotSupported, OperationTimedOut, OutOfRangeInput, OutOfRangeQueryParameterValue, RequestBodyTooLarge, ResourceTypeMismatch, RequestUrlFailedToParse, ResourceAlreadyExists, ResourceBusy, ServerBusy, UnsupportedHeader, Nepodporovaný uzelXmlNode, UnsupportedQueryParameter, UnsupportedHttpVerb, CannotDeleteFileOrDirectory, ClientCacheFlushDelay, DeletePending, DirectoryNotEmpty, FileLockConflict, InvalidFileOrDirectoryPathName, ParentNotFound, ReadOnlyAttribute, ShareAlreadyExists, ShareBeingDeleted, ShareDisabled, ShareNotFound, SharingViolation, ShareSnapshotInProgress, ShareSnapshotCountExceeded, ShareSnapshotCountExceeded, ShareSnapshotOperationNotSupported, ShareHasSnapshots, ContainerQuotaDowngradeNotAllowed

FileAttributesPreserveType

Označuje zachování existujících atributů souboru beze změny.

FilePermissionInheritType

Označuje dědění oprávnění k souboru z nadřazeného adresáře.

FilePermissionPreserveType

Označuje zachování stávající hodnoty oprávnění k souboru beze změny.

TimeNowType

Označuje nastavení jako čas požadavku.

TimePreserveType

Označuje zachování stávající časové hodnoty beze změny.

Operation

Operace je asynchronní funkce, která se má spustit a spravovat službou Batch.

OutgoingHandler

OutgoingHandler je asynchronní funkce aktivovaná bufferSchedulerem.

ReadableStreamGetter

Výčty

SASProtocol

Protokoly pro vygenerovaný SAS.

RetryPolicyType

Typy RetryPolicy.

Funkce

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME. Vygeneruje objekt <xref:SASQueryParameters>, který obsahuje všechny parametry dotazu SAS potřebné k provedení skutečného požadavku REST.

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME. Vytvoří instanci SASQueryParameters.

Přijímá pouze požadovaná nastavení potřebná k vytvoření sdíleného přístupového podpisu. Pro volitelná nastavení nastavte odpovídající vlastnosti přímo, jako jsou oprávnění, startTime a identifikátor.

UPOZORNĚNÍ: Pokud identifikátor není zadaný, vyžadují se oprávnění a doba vypršení platnosti. Hodnotu musíte přiřadit identifikátoru nebo expiryTime & oprávnění ručně, pokud inicialujete pomocí tohoto konstruktoru.

ipRangeToString(IIPRange)

Vygenerujte řetězec formátu IPRange. Například: 8.8.8.8.8 nebo "1.1.1.1-255.255.255.255"

rangeToString(IRange)

Vygenerujte řetězec rozsahu. Příklad: "bytes=255-" nebo "bytes=0-511"

uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

K DISPOZICI POUZE V PROHLÍŽEČÍCH. Nahraje objekt Blob/File/ArrayBuffer/ArrayBufferView v prohlížeči do souboru Azure.

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne soubor Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné, předání 0 pro stažení celého souboru.

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME. Nahraje místní soubor do souboru Azure.

uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME. Nahraje stream Node.js čitelný do souboru Azure. Tato metoda se pokusí vytvořit Azure a pak začne nahrávat bloky dat podle bloků dat. Velikost bloku dat je definována parametrem bufferSize. Ujistěte se, že potenciální velikost streamu nepřekračuje velikost souboru.

TIPY KE ZLEPŠENÍ VÝKONU:

  • Vstupní datový proud highWaterMark je lepší nastavit stejnou hodnotu s parametrem bufferSize, což zabrání operacím Buffer.concat().
fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)
fileCreationTimeToString(Date | TimeNowType | TimePreserveType)
fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)
validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)
validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)
validateFilePermissionOptions(undefined | string, undefined | string)
NewRetryPolicyFactory(IRetryOptions)

Metoda továrny používaná k vygenerování objektu pro vytváření retryPolicy.

blobToArrayBuffer(Blob)

Převeďte objekt blob prohlížeče na ArrayBuffer.

appendToURLPath(string, string)

Připojte řetězec k cestě URL. Odebere duplicitní znak "/" před řetězcem, když cesta url končí řetězcem "/".

base64decode(string)

Dekódování base64

base64encode(string)

Kódování Base64

delay(number, AbortSignalLike, Error)

Zpoždění zadaného časového intervalu

escapeURLPath(string)

Pro služby Storage, jako je blob nebo soubor, musí být správně uchycené znaky adresy URL.

Kódování adres URL a řídicí strategie pro sady SDK JSv10

Když zákazníci předávají řetězec adresy URL do konstruktoru tříd XXXURL, řetězec adresy URL již může být zakódován nebo ne. Před odesláním na server Azure Storage ale musí být adresa URL zakódovaná. U sady SDK je ale těžké odhadnout, jestli byl řetězec adresy URL kódovaný, nebo ne. Máme 2 potenciální strategie a zvolili jsme strategii 2 pro konstruktory XXXURL.

Strategie Jedna: Předpokládejme, že řetězec adresy URL zákazníka není kódovaný a řetězec adresy URL vždy kódujte v sadě SDK.

To je to, co starší verze sady SDK V2 dělá, jednoduchá a funguje ve většině případů.

  • Pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/b:", sada SDK ho zakóduje na "http://account.blob.core.windows.net/con/b%3A" a odeslat na server. Vytvoří se objekt blob s názvem b:.
  • Pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/b%3A", sada SDK ho zakóduje na "http://account.blob.core.windows.net/con/b%253A" a odeslat na server. Vytvoří se objekt blob s názvem b%3A.

Tato strategie ale nebude moct v názvu vytvořit objekt blob s textem "?" . Protože pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/blob?name", název "?name" se bude místo názvu objektu blob považovat za paramter adresy URL. Pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/blob%3Fname", vytvoří se objekt blob s názvem "blob%3Fname". Sada SDK V2 tento problém nemá, protože neumožňuje zákazníkovi předat úplnou adresu URL, přijímá pro něj samostatný název objektu blob a kódovat kódURIComponent. Nemůžeme přijmout sadu SDK, nemůžeme vytvořit název objektu blob s textem "?". Proto implementujeme strategii dvě:

Strategie 2: Sada SDK nepředpokládá, že je adresa URL zakódovaná nebo ne. Prostě unikne speciálním znakům.

To je to, co dělá sada SDK V10 Blob Go. Přijímá typ adresy URL v Go a adresu URL volání. EscapedPath() pro únik speciální znaky unescaped.

  • Pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/b:", sada SDK unikne ":" like "http://account.blob.core.windows.net/con/b%3A" a odeslat na server. Vytvoří se objekt blob s názvem b:.
  • Pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/b%3A", neexistují žádné speciální znaky, takže odešlete "http://account.blob.core.windows.net/con/b%3A" na server. Vytvoří se objekt blob s názvem b:.
  • Pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/b%253A", neexistují žádné speciální znaky, takže odešlete "http://account.blob.core.windows.net/con/b%253A" na server. Vytvoří se objekt blob s názvem b%3A.

Tato strategie nám dává flexibilitu při vytváření se speciálními znaky. Ale "%" bude považován za speciální znaky, pokud řetězec adresy URL není kódován, neměl by v řetězci adresy URL existovat "%", jinak adresa URL není platná adresa URL. Pokud zákazník potřebuje vytvořit objekt blob s "%" v názvu objektu blob, použijte "%25" insead of "%". Stejně jako u výše uvedené třetí ukázky. Následující řetězce adresy URL jsou neplatné:

  • "http://account.blob.core.windows.net/con/b%"
  • "http://account.blob.core.windows.net/con/b%2"
  • "http://account.blob.core.windows.net/con/b%G"

Dalším speciálním znakem je "?", použijte "%2F" k reprezentaci názvu objektu blob s "?" v řetězci adresy URL.

Strategie pro containerName, blobName nebo jiné specifické parametry XXXName v metodách, jako je BlobURL.fromContainerURL(containerURL, blobName)

Použijeme strategii jedna a pro tyto parametry, jako je blobName, zavoláme encodeURIComponent. Vzhledem k tomu, že to, co zákazníci předá, je prostý název místo adresy URL.

getURLParameter(string, string)

Získání parametru adresy URL podle názvu

getURLPath(string)

Získejte cestu url z řetězce adresy URL.

getURLQueries(string)

Získejte páry hodnot klíče dotazu URL z řetězce adresy URL.

padStart(string, number, undefined | string)

String.prototype.padStart()

setURLHost(string, string)

Nastavte hostitele adresy URL.

setURLParameter(string, string, undefined | string)

Nastavte název a hodnotu parametru adresy URL. Pokud název v parametrech adresy URL existuje, nahradí se stará hodnota klíčem name. Pokud nezadáte hodnotu, parametr se odstraní.

truncatedISO8061Date(Date, undefined | false | true)

Zaokrouhlí datum na sekundy.

streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Čte čitelný datový proud do vyrovnávací paměti. Vyplňte vyrovnávací paměť od posunu na konec.

Podrobnosti funkce

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME. Vygeneruje objekt <xref:SASQueryParameters>, který obsahuje všechny parametry dotazu SAS potřebné k provedení skutečného požadavku REST.

function generateAccountSASQueryParameters(accountSASSignatureValues: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parametry

accountSASSignatureValues
IAccountSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Návraty

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME. Vytvoří instanci SASQueryParameters.

Přijímá pouze požadovaná nastavení potřebná k vytvoření sdíleného přístupového podpisu. Pro volitelná nastavení nastavte odpovídající vlastnosti přímo, jako jsou oprávnění, startTime a identifikátor.

UPOZORNĚNÍ: Pokud identifikátor není zadaný, vyžadují se oprávnění a doba vypršení platnosti. Hodnotu musíte přiřadit identifikátoru nebo expiryTime & oprávnění ručně, pokud inicialujete pomocí tohoto konstruktoru.

function generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parametry

fileSASSignatureValues
IFileSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Návraty

ipRangeToString(IIPRange)

Vygenerujte řetězec formátu IPRange. Například: 8.8.8.8.8 nebo "1.1.1.1-255.255.255.255"

function ipRangeToString(ipRange: IIPRange)

Parametry

ipRange
IIPRange

Návraty

string

rangeToString(IRange)

Vygenerujte řetězec rozsahu. Příklad: "bytes=255-" nebo "bytes=0-511"

function rangeToString(iRange: IRange)

Parametry

iRange
IRange

Návraty

string

uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

K DISPOZICI POUZE V PROHLÍŽEČÍCH. Nahraje objekt Blob/File/ArrayBuffer/ArrayBufferView v prohlížeči do souboru Azure.

function uploadBrowserDataToAzureFile(aborter: Aborter, browserData: Blob | ArrayBuffer | ArrayBufferView, fileURL: FileURL, options?: IUploadToAzureFileOptions)

Parametry

aborter
Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

browserData

Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer nebo ArrayBufferView

fileURL
FileURL

Návraty

Promise<void>

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne soubor Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné, předání 0 pro stažení celého souboru.

function downloadAzureFileToBuffer(aborter: Aborter, buffer: Buffer, fileURL: FileURL, offset: number, count?: undefined | number, options?: IDownloadFromAzureFileOptions)

Parametry

aborter
Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

buffer

Buffer

Vyrovnávací paměť, která se má vyplnit, musí mít délku větší než počet.

fileURL
FileURL

Objekt FileURL

offset

number

Ze které pozice souboru Azure ke stažení

count

undefined | number

Návraty

Promise<void>

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME. Nahraje místní soubor do souboru Azure.

function uploadFileToAzureFile(aborter: Aborter, filePath: string, fileURL: FileURL, options?: IUploadToAzureFileOptions)

Parametry

aborter
Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

filePath

string

Úplná cesta k místnímu souboru

fileURL
FileURL

FileURL

Návraty

Promise<void>

uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME. Nahraje stream Node.js čitelný do souboru Azure. Tato metoda se pokusí vytvořit Azure a pak začne nahrávat bloky dat podle bloků dat. Velikost bloku dat je definována parametrem bufferSize. Ujistěte se, že potenciální velikost streamu nepřekračuje velikost souboru.

TIPY KE ZLEPŠENÍ VÝKONU:

  • Vstupní datový proud highWaterMark je lepší nastavit stejnou hodnotu s parametrem bufferSize, což zabrání operacím Buffer.concat().
function uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions)

Parametry

aborter
Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

stream

Readable

Node.js čitelný datový proud. Musí být menší nebo rovna velikosti souboru.

size

number

Velikost souboru, který se má vytvořit. Maximální povolená velikost je 1 TB. Pokud je tato hodnota větší než velikost datového proudu, budou prázdné bajty v chvostu souboru.

fileURL
FileURL

Instance FileURL

bufferSize

number

Velikost každé vyrovnávací paměti přidělené v bajtech, také velikost bloku/rozsahu během nahraného souboru. Velikost musí být > 0 a <= 4 × 1024 × 1024 (4 MB)

maxBuffers

number

Maximální počet vyrovnávacích pamětí se přidělí během nahrávání, pozitivní korelace s maximální souběžností nahrávání

Návraty

Promise<void>

fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)

function fileAttributesToString(fileAttributes: FileSystemAttributes | FileAttributesPreserveType)

Parametry

Návraty

string

fileCreationTimeToString(Date | TimeNowType | TimePreserveType)

function fileCreationTimeToString(time: Date | TimeNowType | TimePreserveType)

Parametry

Návraty

string

fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)

function fileLastWriteTimeToString(time: Date | TimeNowType | TimePreserveType)

Parametry

Návraty

string

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)

function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: IFileAndDirectoryCreateCommonOptions)

Parametry

Návraty

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)

function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: IFileAndDirectorySetPropertiesCommonOptions)

Parametry

Návraty

validateFilePermissionOptions(undefined | string, undefined | string)

function validateFilePermissionOptions(filePermission?: undefined | string, filePermissionKey?: undefined | string)

Parametry

filePermission

undefined | string

filePermissionKey

undefined | string

NewRetryPolicyFactory(IRetryOptions)

Metoda továrny používaná k vygenerování objektu pro vytváření retryPolicy.

function NewRetryPolicyFactory(retryOptions?: IRetryOptions)

Parametry

retryOptions
IRetryOptions

Návraty

RequestPolicyFactory

blobToArrayBuffer(Blob)

Převeďte objekt blob prohlížeče na ArrayBuffer.

function blobToArrayBuffer(blob: Blob)

Parametry

blob

Blob

Návraty

Promise<ArrayBuffer>

appendToURLPath(string, string)

Připojte řetězec k cestě URL. Odebere duplicitní znak "/" před řetězcem, když cesta url končí řetězcem "/".

function appendToURLPath(url: string, name: string)

Parametry

url

string

Řetězec zdrojové adresy URL

name

string

Řetězec, který se má připojit k adrese URL

Návraty

string

Aktualizovaný řetězec adresy URL

base64decode(string)

Dekódování base64

function base64decode(encodedString: string)

Parametry

encodedString

string

Návraty

string

base64encode(string)

Kódování Base64

function base64encode(content: string)

Parametry

content

string

Návraty

string

delay(number, AbortSignalLike, Error)

Zpoždění zadaného časového intervalu

function delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error)

Parametry

timeInMs

number

aborter

AbortSignalLike

abortError

Error

Návraty

Promise<unknown>

escapeURLPath(string)

Pro služby Storage, jako je blob nebo soubor, musí být správně uchycené znaky adresy URL.

Kódování adres URL a řídicí strategie pro sady SDK JSv10

Když zákazníci předávají řetězec adresy URL do konstruktoru tříd XXXURL, řetězec adresy URL již může být zakódován nebo ne. Před odesláním na server Azure Storage ale musí být adresa URL zakódovaná. U sady SDK je ale těžké odhadnout, jestli byl řetězec adresy URL kódovaný, nebo ne. Máme 2 potenciální strategie a zvolili jsme strategii 2 pro konstruktory XXXURL.

Strategie Jedna: Předpokládejme, že řetězec adresy URL zákazníka není kódovaný a řetězec adresy URL vždy kódujte v sadě SDK.

To je to, co starší verze sady SDK V2 dělá, jednoduchá a funguje ve většině případů.

  • Pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/b:", sada SDK ho zakóduje na "http://account.blob.core.windows.net/con/b%3A" a odeslat na server. Vytvoří se objekt blob s názvem b:.
  • Pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/b%3A", sada SDK ho zakóduje na "http://account.blob.core.windows.net/con/b%253A" a odeslat na server. Vytvoří se objekt blob s názvem b%3A.

Tato strategie ale nebude moct v názvu vytvořit objekt blob s textem "?" . Protože pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/blob?name", název "?name" se bude místo názvu objektu blob považovat za paramter adresy URL. Pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/blob%3Fname", vytvoří se objekt blob s názvem "blob%3Fname". Sada SDK V2 tento problém nemá, protože neumožňuje zákazníkovi předat úplnou adresu URL, přijímá pro něj samostatný název objektu blob a kódovat kódURIComponent. Nemůžeme přijmout sadu SDK, nemůžeme vytvořit název objektu blob s textem "?". Proto implementujeme strategii dvě:

Strategie 2: Sada SDK nepředpokládá, že je adresa URL zakódovaná nebo ne. Prostě unikne speciálním znakům.

To je to, co dělá sada SDK V10 Blob Go. Přijímá typ adresy URL v Go a adresu URL volání. EscapedPath() pro únik speciální znaky unescaped.

  • Pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/b:", sada SDK unikne ":" like "http://account.blob.core.windows.net/con/b%3A" a odeslat na server. Vytvoří se objekt blob s názvem b:.
  • Pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/b%3A", neexistují žádné speciální znaky, takže odešlete "http://account.blob.core.windows.net/con/b%3A" na server. Vytvoří se objekt blob s názvem b:.
  • Pokud je řetězec adresy URL zákazníka "http://account.blob.core.windows.net/con/b%253A", neexistují žádné speciální znaky, takže odešlete "http://account.blob.core.windows.net/con/b%253A" na server. Vytvoří se objekt blob s názvem b%3A.

Tato strategie nám dává flexibilitu při vytváření se speciálními znaky. Ale "%" bude považován za speciální znaky, pokud řetězec adresy URL není kódován, neměl by v řetězci adresy URL existovat "%", jinak adresa URL není platná adresa URL. Pokud zákazník potřebuje vytvořit objekt blob s "%" v názvu objektu blob, použijte "%25" insead of "%". Stejně jako u výše uvedené třetí ukázky. Následující řetězce adresy URL jsou neplatné:

  • "http://account.blob.core.windows.net/con/b%"
  • "http://account.blob.core.windows.net/con/b%2"
  • "http://account.blob.core.windows.net/con/b%G"

Dalším speciálním znakem je "?", použijte "%2F" k reprezentaci názvu objektu blob s "?" v řetězci adresy URL.

Strategie pro containerName, blobName nebo jiné specifické parametry XXXName v metodách, jako je BlobURL.fromContainerURL(containerURL, blobName)

Použijeme strategii jedna a pro tyto parametry, jako je blobName, zavoláme encodeURIComponent. Vzhledem k tomu, že to, co zákazníci předá, je prostý název místo adresy URL.

function escapeURLPath(url: string)

Parametry

url

string

Návraty

string

getURLParameter(string, string)

Získání parametru adresy URL podle názvu

function getURLParameter(url: string, name: string)

Parametry

url

string

name

string

Návraty

string | string[] | undefined

getURLPath(string)

Získejte cestu url z řetězce adresy URL.

function getURLPath(url: string)

Parametry

url

string

Řetězec zdrojové adresy URL

Návraty

string | undefined

getURLQueries(string)

Získejte páry hodnot klíče dotazu URL z řetězce adresy URL.

function getURLQueries(url: string)

Parametry

url

string

Návraty

[key: string]: string

padStart(string, number, undefined | string)

String.prototype.padStart()

function padStart(currentString: string, targetLength: number, padString?: undefined | string)

Parametry

currentString

string

targetLength

number

padString

undefined | string

Návraty

string

setURLHost(string, string)

Nastavte hostitele adresy URL.

function setURLHost(url: string, host: string)

Parametry

url

string

Řetězec zdrojové adresy URL

host

string

Nový řetězec hostitele

Návraty

string

Aktualizovaný řetězec adresy URL

setURLParameter(string, string, undefined | string)

Nastavte název a hodnotu parametru adresy URL. Pokud název v parametrech adresy URL existuje, nahradí se stará hodnota klíčem name. Pokud nezadáte hodnotu, parametr se odstraní.

function setURLParameter(url: string, name: string, value?: undefined | string)

Parametry

url

string

Řetězec zdrojové adresy URL

name

string

Název parametru

value

undefined | string

Návraty

string

Aktualizovaný řetězec adresy URL

truncatedISO8061Date(Date, undefined | false | true)

Zaokrouhlí datum na sekundy.

function truncatedISO8061Date(date: Date, withMilliseconds?: undefined | false | true)

Parametry

date

Date

withMilliseconds

undefined | false | true

Návraty

string

Řetězec data ve formátu ISO8061 s komponentou 7 milisekund nebo bez

streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Čte čitelný datový proud do vyrovnávací paměti. Vyplňte vyrovnávací paměť od posunu na konec.

function streamToBuffer(stream: ReadableStream, buffer: Buffer, offset: number, end: number, encoding?: undefined | string)

Parametry

stream

ReadableStream

Node.js čitelný datový proud

buffer

Buffer

Vyrovnávací paměť, která se má vyplnit, musí >= posun

offset

number

Ze které pozice ve vyrovnávací paměti, která má být vyplněna, včetně

end

number

Na kterou pozici ve vyrovnávací paměti se má vyplnit, s výhradním

encoding

undefined | string

Návraty

Promise<void>