Megosztás a következőn keresztül:


@azure/storage-file package

Osztályok

Aborter

Az aborter-példány implementálja az AbortSignal felületet, megszakíthatja a HTTP-kéréseket.

  • Hívja meg az Aborter.none parancsot, hogy időtúllépés nélkül hozzon létre egy új Aborter-példányt.
  • Az Aborter.timeout() meghívásával hozzon létre egy új Aborter-példányt időtúllépéssel.

Meglévő példány megszakítása esetén:

  • Az aborter.withTimeout() meghívásával hozzon létre és adjon vissza egy gyermek Aborter-példányt időtúllépéssel.
  • Az aborter.withValue(kulcs, érték) hívásával hozzon létre és adjon vissza egy gyermek Aborter-példányt kulcs/érték pár használatával.
  • Az aborter.abort() hívása az aktuális példány és az összes gyermekpéldány megszakításához.
  • Az aborter.getValue(kulcs) hívásával megkeresheti és lekérheti a megfelelő kulccsal rendelkező értéket az aktuális megszakítástól az összes szülőig.
AccountSASPermissions

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Ez egy segédosztály, amely egy AccountSAS által megadott engedélyeket képviselő sztringet hoz létre. Az érték igaz értékre állítása azt jelenti, hogy az ezen engedélyeket használó SAS engedélyeket ad a művelethez. Miután az összes érték be van állítva, ezt a toStringgel kell szerializálni, és egy <xref:IAccountSASSignatureValues> objektum engedélymezőjeként kell beállítani. Az engedélysztring az osztály nélkül is felépíthető, de az engedélyek sorrendje különleges, és ez az osztály garantálja a helyességet.

AccountSASResourceTypes

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Ez egy segédosztály egy, az AccountSAS által elérhető erőforrásokat képviselő sztring létrehozásához. Az érték igaz értékre állítása azt jelenti, hogy az ezen engedélyeket használó sasok hozzáférést biztosítanak az adott erőforrástípushoz. Miután az összes érték be van állítva, ezt a toStringgel kell szerializálni, és egy <xref:IAccountSASSignatureValues> objektum erőforrásmezőjeként kell beállítani. Az erőforrás-sztring ezen osztály nélkül is felépíthető, de az erőforrások sorrendje különleges, és ez az osztály garantálja a helyességet.

AccountSASServices

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Ez egy segédosztály, amely egy, az AccountSAS által elérhető szolgáltatásokat képviselő sztringet hoz létre. Az érték igaz értékre állítása azt jelenti, hogy az engedélyeket használó SAS hozzáférést biztosít az adott szolgáltatáshoz. Miután az összes érték be van állítva, ezt a toStringgel kell szerializálni, és egy <xref:IAccountSASSignatureValues> objektum szolgáltatásmezőjeként kell beállítani. A szolgáltatási sztring ezen osztály nélkül is felépíthető, de a szolgáltatások sorrendje különleges, és ez az osztály garantálja a helyességet.

BrowserPolicyFactory

A BrowserPolicyFactory egy gyári osztály, amely segít a BrowserPolicy-objektumok létrehozásában.

DirectoryURL

A CímtárURL az Azure Storage-címtár URL-címét jelöli, amely lehetővé teszi a fájlok és könyvtárak manipulálását.

FileSASPermissions

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Ez egy segédosztály egy olyan sztring létrehozásához, amely a ServiceSAS által a fájlhoz adott engedélyeket jelöli. Az érték igaz értékre állítása azt jelenti, hogy az ezen engedélyeket használó SAS engedélyeket ad a művelethez. Miután az összes érték be van állítva, ezt szerializálni kell a toString használatával, és be kell állítani egy <xref:IFileSASSignatureValues> objektum engedélymezőjeként. Az engedélysztring az osztály nélkül is felépíthető, de az engedélyek sorrendje különleges, és ez az osztály garantálja a helyességet.

FileSystemAttributes

Ez egy segédosztály, amely egy fájlhoz vagy könyvtárhoz tartozó NTFS-attribútumokat képviselő sztringet hoz létre.

FileURL

A FileURL egy Azure Storage-fájl URL-címét jelöli.

KeepAlivePolicyFactory

A KeepAlivePolicyFactory egy gyári osztály, amely segít a KeepAlivePolicy objektumok létrehozásában.

LoggingPolicyFactory

A LoggingPolicyFactory egy gyári osztály, amely segít a LoggingPolicy-objektumok létrehozásában.

Pipeline

HTTP-kérési szabályzatokat tartalmazó folyamatosztály. Az alapértelmezett folyamatot a StorageURL.newPipeline() meghívásával hozhatja létre. Vagy létrehozhat egy saját szabályzatokkal rendelkező folyamatot a Pipeline konstruktorával. A testreszabott folyamat implementálása előtt tekintse meg a StorageURL.newPipeline() és a megadott szabályzatok hivatkozását.

RetryPolicyFactory

A RetryPolicyFactory egy gyári osztály, amely segít a RetryPolicy-objektumok létrehozásában.

SASQueryParameters

Az Azure Storage SAS lekérdezési paramétereit alkotó összetevőket jelöli. Ezt a típust nem közvetlenül a felhasználó készíti el; csak a <xref:IAccountSASSignatureValues> és <xref:IFileSASSignatureValues> típusok generálják. A létrehozás után kódolható egy {@code String}-be, és közvetlenül hozzáfűzhető egy URL-címhez (itt azonban körültekintően kell eljárni, ha vannak meglévő lekérdezési paraméterek, amelyek befolyásolhatják a lekérdezési paraméterek hozzáfűzésének megfelelő módját). MEGJEGYZÉS: Az osztály példányai nem módosíthatók.

ServiceURL

A ServiceURL az Azure Storage-fájlszolgáltatás URL-címét jelöli, amely lehetővé teszi a fájlmegosztások manipulálását.

ShareSASPermissions

Ez egy segédosztály, amely egy olyan sztringet hoz létre, amely a ServiceSAS által a megosztáshoz adott engedélyeket jelöli. Az érték igaz értékre állítása azt jelenti, hogy az ezen engedélyeket használó SAS engedélyeket ad a művelethez. Miután az összes érték be van állítva, ezt szerializálni kell a toString használatával, és be kell állítani egy <xref:IFileSASSignatureValues> objektum engedélymezőjeként. Az engedélysztring az osztály nélkül is felépíthető, de az engedélyek sorrendje különleges, és ez az osztály garantálja a helyességet.

ShareURL

A ShareURL az Azure Storage-megosztás URL-címét jelöli, amely lehetővé teszi a címtárak és fájlok manipulálását.

StorageURL

A ServiceURL a ServiceURL, a ContainerURL stb.

TelemetryPolicyFactory

A TelemetryPolicyFactory egy gyári osztály, amely segít a TelemetryPolicy-objektumok létrehozásában.

UniqueRequestIDPolicyFactory

A UniqueRequestIDPolicyFactory egy gyári osztály, amely segít a UniqueRequestIDPolicy objektumok létrehozásában.

AnonymousCredential

Az AnonymousCredential egy hitelesítőadatPolicyCreator-tagot biztosít, amellyel AnonymousCredentialPolicy objektumokat hozhat létre. Az AnonymousCredentialPolicy olyan HTTP-kérésekkel használható, amelyek nyilvános erőforrásokat olvasnak, vagy közös hozzáférésű jogosultságkódokkal (SAS) használják.

Credential

A hitelesítő adatok az Azure Storage HTTP-kérések aláírásának absztrakt osztályai. Ez az osztály egy credentialPolicyCreator gyárat fog üzemeltetni, amely credentialPolicy-t hoz létre.

SharedKeyCredential

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. SharedKeyCredential az Azure Storage szolgáltatás fiókkulcs-engedélyezéséhez.

Directory

Könyvtárat képviselő osztály.

File

Fájlokat képviselő osztály.

Service

Egy szolgáltatást képviselő osztály.

Share

Megosztást képviselő osztály.

StorageClient
StorageClientContext
AnonymousCredentialPolicy

Az AnonymousCredentialPolicy olyan HTTP-kérésekkel használható, amelyek nyilvános erőforrásokat olvasnak, vagy közös hozzáférésű jogosultságkódokkal (SAS) használják.

BrowserPolicy

A BrowserPolicy kezeli a Node.js és a böngésző futtatókörnyezete közötti különbségeket, beleértve a következőket:

  1. A böngészők a GET/HEAD kéréseket feltételes fejlécek, például a "IF_MODIFIED_SINCE" hozzáadásával gyorsítótárazják. A BrowserPolicy egy szabályzat, amellyel időbélyeg-lekérdezést adhat hozzá a GET/HEAD kérelem URL-címéhez, így elkerülhető a böngésző gyorsítótára.

  2. Cookie-fejléc eltávolítása a biztonság érdekében

  3. Tartalomhosszúságú fejléc eltávolítása a böngészők figyelmeztetésének elkerülése érdekében

CredentialPolicy

A HTTP(S) kérések elküldése előtt történő aláírásához használt hitelesítőadat-szabályzat. Ez egy absztrakt osztály.

KeepAlivePolicy

A KeepAlivePolicy egy olyan szabályzat, amellyel szabályozható az életben tartási beállítások minden kéréshez.

LoggingPolicy

A LoggingPolicy a kérések naplózására szolgáló szabályzat.

RetryPolicy

Újrapróbálkozási szabályzat exponenciális újrapróbálkozással és lineáris újrapróbálkozással.

SharedKeyCredentialPolicy

A SharedKeyCredentialPolicy egy olyan szabályzat, amellyel HTTP-kéréseket írhat alá megosztott kulccsal.

TelemetryPolicy

A TelemetryPolicy egy olyan szabályzat, amellyel minden kéréshez megcímkézheti a felhasználó-ügynök fejlécét.

UniqueRequestIDPolicy

A UniqueRequestIDPolicy egy UUID-t hoz létre x-ms-request-id fejlécértékként.

Batch

A Batch alapszintű párhuzamos végrehajtást biztosít egyidejűségi korlátokkal. Leállítja a bal oldali műveletek végrehajtását, ha az egyik végrehajtott művelet hibát jelez. A Batch azonban nem tudja megszakítani a folyamatban lévő műveleteket, saját maga kell lemondania őket.

BufferScheduler

Ez az osztály bemenetként elfogad egy Node.js olvasható adatfolyamot, és a streamből származó adatokat a belső pufferstruktúrába olvassa, amíg el nem éri a maxBuffers értéket. Minden elérhető puffer megpróbálja aktiválni a outgoingHandlert. A belső pufferstruktúra tartalmaz egy bejövő puffertömböt és egy kimenő puffertömböt. A bejövő puffertömb tartalmazza az "üres" puffereket, amelyek új bejövő adatokkal tölthetők fel. A kimenő tömb tartalmazza azokat a kitöltött puffereket, amelyeket a outgoingHandler kezel. Minden fenti pufferméretet a bufferSize paraméter határoz meg.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

NUM_OF_ALL_BUFFERS <= maxBuffers

TELJESÍTMÉNYJAVÍTÁSI TIPPEK:

  1. A bemeneti stream highWaterMark tulajdonsága jobb, ha ugyanazt az értéket a bufferSize paraméterrel állítja be, így elkerülhetők a Puffer.concat() műveletek.
  2. A párhuzamosságnak kisebb értéket kell beállítania, mint a maxBuffers, ami segít csökkenteni annak lehetőségét, hogy a kimenő kezelő megvárja a streamadatokat. ebben az esetben a kimenő kezelők le vannak tiltva. A kimenő üzenetsor nem lehet üres.
RetriableReadableStream

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. A Node.js ReadableStream belsőleg újrapróbálkozza, ha a belső ReadableStream váratlanul véget ér.

Interfészek

IDirectoryCreateOptions
IDirectoryForceCloseHandlesSegmentOptions
IDirectoryListFilesAndDirectoriesSegmentOptions
IDirectoryListHandlesSegmentOptions
IDirectoryProperties
IFileCreateOptions
IFileDownloadOptions
IFileGetRangeListOptions

A beállítás a REST-definíció paritásaként van definiálva. Bár ez még nem áll készen a használatra, figyelembe véve, hogy a forrástartalom Crc64 nem érhető el.

IFileListHandlesSegmentOptions
IFileProperties
IFileStartCopyOptions
IFileUploadRangeOptions
ISetPropertiesResponse
IAccountSASSignatureValues

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Az IAccountSASSignatureValues használatával közös hozzáférésű jogosultságkód (SAS) jön létre egy Azure Storage-fiókhoz. Miután az összes érték megfelelően be van állítva, hívja meg a generateSASQueryParameters() metódust, hogy lekérje az SAS-t, amely ténylegesen alkalmazható a fájl URL-címére. Vegye figyelembe, hogy ez az osztály és <xref:SASQueryParameters> is létezik, mert az előbbi mutable és logikai ábrázolás, míg az utóbbi nem módosítható, és a tényleges REST-kérések létrehozására szolgál.

IFileSASSignatureValues

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Az IFileSASSignatureValues fájlszolgáltatás SAS-jogkivonatainak létrehozására szolgál a megosztásokhoz vagy fájlokhoz.

IIPRange

SAS-hez engedélyezett IP-címtartomány.

IRange

Szolgáltatásműveletek tartománya.

IKeepAliveOptions

A KeepAlivePolicy beállításainak felülete.

IRequestLogOptions

A RequestLogOptions konfigurálja az újrapróbálkozási szabályzat viselkedését.

IPipelineOptions

A Folyamatkonstruktor beállítási felülete.

IRetryOptions

Próbálkozzon újra a beállítások felületével.

IServiceListSharesSegmentOptions
IShareCreateOptions
IShareCreateSnapshotOptions
IShareDeleteMethodOptions
ISignedIdentifier
INewPipelineOptions

Option interface for Pipeline.newPipeline metódus.

ITelemetryOptions

A TelemetryPolicy beállításainak felülete.

AccessPolicy

Hozzáférési szabályzat.

CorsRule

A CORS egy HTTP-funkció, amely lehetővé teszi, hogy az egyik tartomány alatt futó webalkalmazás hozzáférjen egy másik tartomány erőforrásaihoz. A webböngészők olyan, azonos eredetű szabályzatként ismert biztonsági korlátozást implementálnak, amely megakadályozza, hogy egy weblap más tartományban hívja meg az API-kat; A CORS biztonságos módot biztosít arra, hogy az egyik tartomány (a forrástartomány) meghívhassa az API-kat egy másik tartományban.

DirectoryCreateHeaders

A Létrehozás művelet fejléceit határozza meg.

DirectoryCreateOptionalParams

Nem kötelező paraméterek.

DirectoryDeleteHeaders

A Delete művelet fejléceit határozza meg.

DirectoryDeleteMethodOptionalParams

Nem kötelező paraméterek.

DirectoryForceCloseHandlesHeaders

A ForceCloseHandles művelet fejléceit határozza meg.

DirectoryForceCloseHandlesOptionalParams

Nem kötelező paraméterek.

DirectoryGetPropertiesHeaders

A GetProperties művelet fejléceit határozza meg.

DirectoryGetPropertiesOptionalParams

Nem kötelező paraméterek.

DirectoryItem

Egy listázott könyvtárelem.

DirectoryListFilesAndDirectoriesSegmentHeaders

A ListFilesAndDirectoriesSegment művelet fejléceit határozza meg.

DirectoryListFilesAndDirectoriesSegmentOptionalParams

Nem kötelező paraméterek.

DirectoryListHandlesHeaders

A ListHandles művelet fejléceit határozza meg.

DirectoryListHandlesOptionalParams

Nem kötelező paraméterek.

DirectorySetMetadataHeaders

A SetMetadata művelet fejléceit határozza meg.

DirectorySetMetadataOptionalParams

Nem kötelező paraméterek.

DirectorySetPropertiesHeaders

A SetProperties művelet fejléceit határozza meg.

DirectorySetPropertiesOptionalParams

Nem kötelező paraméterek.

FileAbortCopyHeaders

Az AbortCopy művelet fejléceit határozza meg.

FileAbortCopyOptionalParams

Nem kötelező paraméterek.

FileCreateHeaders

A Létrehozás művelet fejléceit határozza meg.

FileCreateOptionalParams

Nem kötelező paraméterek.

FileDeleteHeaders

A Delete művelet fejléceit határozza meg.

FileDeleteMethodOptionalParams

Nem kötelező paraméterek.

FileDownloadHeaders

A letöltési művelet fejléceit határozza meg.

FileDownloadOptionalParams

Nem kötelező paraméterek.

FileForceCloseHandlesHeaders

A ForceCloseHandles művelet fejléceit határozza meg.

FileForceCloseHandlesOptionalParams

Nem kötelező paraméterek.

FileGetPropertiesHeaders

A GetProperties művelet fejléceit határozza meg.

FileGetPropertiesOptionalParams

Nem kötelező paraméterek.

FileGetRangeListHeaders

A GetRangeList művelet fejléceit határozza meg.

FileGetRangeListOptionalParams

Nem kötelező paraméterek.

FileHTTPHeaders

További paraméterek egy műveletcsoporthoz, például: File_create, File_setHTTPHeaders.

FileItem

Egy felsorolt fájlelem.

FileListHandlesHeaders

A ListHandles művelet fejléceit határozza meg.

FileListHandlesOptionalParams

Nem kötelező paraméterek.

FileProperty

Fájltulajdonságok.

FileSetHTTPHeadersHeaders

A SETHTTPHeaders művelet fejléceit határozza meg.

FileSetHTTPHeadersOptionalParams

Nem kötelező paraméterek.

FileSetMetadataHeaders

A SetMetadata művelet fejléceit határozza meg.

FileSetMetadataOptionalParams

Nem kötelező paraméterek.

FileStartCopyHeaders

A StartCopy-művelet fejléceit határozza meg.

FileStartCopyOptionalParams

Nem kötelező paraméterek.

FileUploadRangeFromURLHeaders

Az UploadRangeFromURL művelet fejléceit határozza meg.

FileUploadRangeFromURLOptionalParams

Nem kötelező paraméterek.

FileUploadRangeHeaders

Az UploadRange művelet fejléceit határozza meg.

FileUploadRangeOptionalParams

Nem kötelező paraméterek.

FilesAndDirectoriesListSegment

A címtárból listázható bejegyzések kivonata.

HandleItem

Egy listában szereplő Azure Storage-leíróelem.

ListFilesAndDirectoriesSegmentResponse

Könyvtárak és fájlok számbavétele.

ListHandlesResponse

Fogópontok számbavétele.

ListSharesResponse

A megosztások számbavétele.

Metrics

Storage Analytics-metrikák a fájlszolgáltatáshoz.

Permission

A Security Descriptor Definition Language(SDDL) által leírt engedély (biztonsági leíró).

Range

Egy Azure Storage-fájltartomány.

RetentionPolicy

Az adatmegőrzési szabályzat.

ServiceGetPropertiesHeaders

A GetProperties művelet fejléceit határozza meg.

ServiceGetPropertiesOptionalParams

Nem kötelező paraméterek.

ServiceListSharesSegmentHeaders

A ListSharesSegment művelet fejléceit határozza meg.

ServiceListSharesSegmentOptionalParams

Nem kötelező paraméterek.

ServiceSetPropertiesHeaders

A SetProperties művelet fejléceit határozza meg.

ServiceSetPropertiesOptionalParams

Nem kötelező paraméterek.

ShareCreateHeaders

A Létrehozás művelet fejléceit határozza meg.

ShareCreateOptionalParams

Nem kötelező paraméterek.

ShareCreatePermissionHeaders

A CreatePermission művelet fejléceit határozza meg.

ShareCreatePermissionOptionalParams

Nem kötelező paraméterek.

ShareCreateSnapshotHeaders

A CreateSnapshot művelet fejléceit határozza meg.

ShareCreateSnapshotOptionalParams

Nem kötelező paraméterek.

ShareDeleteHeaders

A Delete művelet fejléceit határozza meg.

ShareDeleteMethodOptionalParams

Nem kötelező paraméterek.

ShareGetAccessPolicyHeaders

A GetAccessPolicy művelet fejléceit határozza meg.

ShareGetAccessPolicyOptionalParams

Nem kötelező paraméterek.

ShareGetPermissionHeaders

A GetPermission művelet fejléceit határozza meg.

ShareGetPermissionOptionalParams

Nem kötelező paraméterek.

ShareGetPropertiesHeaders

A GetProperties művelet fejléceit határozza meg.

ShareGetPropertiesOptionalParams

Nem kötelező paraméterek.

ShareGetStatisticsHeaders

A GetStatistics művelet fejléceit határozza meg.

ShareGetStatisticsOptionalParams

Nem kötelező paraméterek.

ShareItem

Egy listában szereplő Azure Storage-megosztási elem.

ShareProperties

Egy megosztás tulajdonságai.

ShareSetAccessPolicyHeaders

A SetAccessPolicy művelet fejléceit határozza meg.

ShareSetAccessPolicyOptionalParams

Nem kötelező paraméterek.

ShareSetMetadataHeaders

A SetMetadata művelet fejléceit határozza meg.

ShareSetMetadataOptionalParams

Nem kötelező paraméterek.

ShareSetQuotaHeaders

A SetQuota művelet fejléceit határozza meg.

ShareSetQuotaOptionalParams

Nem kötelező paraméterek.

ShareStats

A megosztás statisztikái.

SignedIdentifier

Aláírt azonosító.

SourceModifiedAccessConditions

További paraméterek az uploadRangeFromURL művelethez.

StorageError

A StorageErrort jelképező felület.

StorageServiceProperties

Tárolási szolgáltatás tulajdonságai.

IDownloadFromAzureFileOptions

A DownloadAzurefileToBuffer beállítási felülete.

IUploadToAzureFileOptions

Az uploadFileToAzureFile és az uploadSeekableStreamToAzureFile beállítási felülete.

IUploadStreamToAzureFileOptions

Az uploadStreamToAzureFile beállítási felülete.

IFileAndDirectoryCreateCommonOptions
IFileAndDirectorySetPropertiesCommonOptions
IFileHTTPHeaders
IMetadata
IRetriableReadableStreamOptions

Típusaliasok

FileDownloadResponse

A letöltési művelet válaszadatait tartalmazza.

FileGetRangeListResponse

A getRangeList művelet válaszadatait tartalmazza.

ShareGetAccessPolicyResponse

A getAccessPolicy művelet válaszadatait tartalmazza.

ShareGetStatisticsResponse

A getStatistics művelet válaszadatait tartalmazza.

CredentialPolicyCreator

Egy gyári függvény, amely létrehoz egy új CredentialPolicy-t, amely a megadott nextPolicy-t használja.

CopyStatusType

A CopyStatusType értékeit határozza meg. Lehetséges értékek: "függőben", "sikeres", "megszakítva", "sikertelen"

DeleteSnapshotsOptionType

A DeleteSnapshotsOptionType értékeit határozza meg. A lehetséges értékek a következők: "include"

DirectoryCreateResponse

A létrehozási művelet válaszadatait tartalmazza.

DirectoryDeleteResponse

A deleteMethod művelet válaszadatait tartalmazza.

DirectoryForceCloseHandlesResponse

A forceCloseHandles művelet válaszadatait tartalmazza.

DirectoryGetPropertiesResponse

A getProperties művelet válaszadatait tartalmazza.

DirectoryListFilesAndDirectoriesSegmentResponse

A listFilesAndDirectoriesSegment művelet válaszadatait tartalmazza.

DirectoryListHandlesResponse

A listHandles művelet válaszadatait tartalmazza.

DirectorySetMetadataResponse

A setMetadata művelet válaszadatait tartalmazza.

DirectorySetPropertiesResponse

A setProperties művelet válaszadatait tartalmazza.

FileAbortCopyResponse

Az abortCopy művelet válaszadatait tartalmazza.

FileCreateResponse

A létrehozási művelet válaszadatait tartalmazza.

FileDeleteResponse

A deleteMethod művelet válaszadatait tartalmazza.

FileForceCloseHandlesResponse

A forceCloseHandles művelet válaszadatait tartalmazza.

FileGetPropertiesResponse

A getProperties művelet válaszadatait tartalmazza.

FileListHandlesResponse

A listHandles művelet válaszadatait tartalmazza.

FileRangeWriteType

A FileRangeWriteType értékeit határozza meg. A lehetséges értékek a következők: "update", "clear"

FileSetHTTPHeadersResponse

AhttpHeaders-művelethez tartozó válaszadatokat tartalmazza.

FileSetMetadataResponse

A setMetadata művelet válaszadatait tartalmazza.

FileStartCopyResponse

A startCopy művelet válaszadatait tartalmazza.

FileType

A FileType értékeit határozza meg. A lehetséges értékek a következők: "Fájl"

FileUploadRangeFromURLResponse

A uploadRangeFromURL művelet válaszadatait tartalmazza.

FileUploadRangeResponse

A uploadRange művelet válaszadatait tartalmazza.

ListSharesIncludeType

A ListSharesIncludeType értékeit határozza meg. A lehetséges értékek a következők: "pillanatképek", "metaadatok"

ServiceGetPropertiesResponse

A getProperties művelet válaszadatait tartalmazza.

ServiceListSharesSegmentResponse

A listSharesSegment művelet válaszadatait tartalmazza.

ServiceSetPropertiesResponse

A setProperties művelet válaszadatait tartalmazza.

ShareCreatePermissionResponse

A createPermission művelet válaszadatait tartalmazza.

ShareCreateResponse

A létrehozási művelet válaszadatait tartalmazza.

ShareCreateSnapshotResponse

A createSnapshot művelet válaszadatait tartalmazza.

ShareDeleteResponse

A deleteMethod művelet válaszadatait tartalmazza.

ShareGetPermissionResponse

A getPermission művelet válaszadatait tartalmazza.

ShareGetPropertiesResponse

A getProperties művelet válaszadatait tartalmazza.

ShareSetAccessPolicyResponse

A setAccessPolicy művelet válaszadatait tartalmazza.

ShareSetMetadataResponse

A setMetadata művelet válaszadatait tartalmazza.

ShareSetQuotaResponse

A setQuota művelet válaszadatait tartalmazza.

StorageErrorCode

A StorageErrorCode értékeit határozza meg. Lehetséges értékek: "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", "ResourceNotFound", "ServerBusy", "UnsupportedHeader", ' UnsupportedXmlNode', 'UnsupportedQueryParameter', 'UnsupportedHttpVerb', 'CannotDeleteFileOrDirectory', 'ClientCacheFlushDelay', 'DeletePending', 'DirectoryNotEmpty', 'FileLockConflict', 'InvalidFileOrDirectoryPathName', 'ParentNotFound', 'ReadOnlyAttribute', 'ShareAlreadyExists', 'ShareBeingDeleted', 'ShareDisabled', 'ShareNotFound', 'SharingViolation', 'ShareSnapshotInProgress', 'ShareSnapshotCountExceeded', 'ShareSnapshotOperationNotSupported', ' ShareHasSnapshots", "ContainerQuotaDowngradeNotAllowed"

FileAttributesPreserveType

Azt jelzi, hogy a meglévő fájlattribútumok változatlanok maradnak.

FilePermissionInheritType

Azt jelzi, hogy a szülőkönyvtár örökli a fájlengedélyeket.

FilePermissionPreserveType

Azt jelzi, hogy a meglévő fájlengedély-érték változatlan marad.

TimeNowType

A kérés időpontjaként megadott beállítást jelzi.

TimePreserveType

Azt jelzi, hogy a meglévő időérték változatlan marad.

Operation

A művelet egy aszinkron függvény, amelyet a Batch hajt végre és kezel.

OutgoingHandler

A OutgoingHandler a BufferScheduler által aktivált aszinkron függvény.

ReadableStreamGetter

Enumerációk

SASProtocol

A létrehozott SAS protokolljai.

RetryPolicyType

RetryPolicy-típusok.

Függvények

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Létrehoz egy <xref:SASQueryParameters> objektumot, amely tartalmazza a tényleges REST-kérés létrehozásához szükséges összes SAS-lekérdezési paramétert.

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Létrehoz egy SASQueryParameters-példányt.

Csak az SAS létrehozásához szükséges beállításokat fogadja el. Az opcionális beállításokhoz adja meg közvetlenül a megfelelő tulajdonságokat, például az engedélyeket, a startTime-t és az azonosítót.

FIGYELMEZTETÉS: Ha nincs megadva azonosító, engedélyekre és lejárati időre van szükség. A konstruktor első használatakor manuálisan kell értéket hozzárendelnie az azonosítóhoz vagy a expiryTime & engedélyekhez.

ipRangeToString(IIPRange)

IPRange formátumú sztring létrehozása. Például: "8.8.8.8" vagy "1.1.1.1-255.255.255.255"

rangeToString(IRange)

Tartománysztring létrehozása. Például: "bytes=255-" vagy "bytes=0-511"

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

CSAK BÖNGÉSZŐKBEN ÉRHETŐ EL. Feltölt egy böngésző Blob/File/ArrayBuffer/ArrayBufferView objektumot egy Azure-fájlba.

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

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Egy Azure-fájlt a pufferrel párhuzamosan tölt le. Az eltolás és a darabszám megadása nem kötelező, a teljes fájl letöltéséhez adja meg a 0-t.

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Feltölt egy helyi fájlt egy Azure-fájlba.

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

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Egy Node.js olvasható streamet tölt fel egy Azure-fájlba. Ez a módszer megpróbál létrehozni egy Azure-t, majd megkezdi a darabkák adattömb szerinti feltöltését. Az adattömb méretét bufferSize paraméter határozza meg. Győződjön meg arról, hogy a stream lehetséges mérete nem haladja meg a fájlméretet.

TELJESÍTMÉNYJAVÍTÁSI TIPPEK:

  • A bemeneti stream highWaterMark tulajdonsága jobb, ha ugyanazt az értéket a bufferSize paraméterrel állítja be, így elkerülhetők a Puffer.concat() műveletek.
fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)
fileCreationTimeToString(Date | TimeNowType | TimePreserveType)
fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)
validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)
validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)
validateFilePermissionOptions(undefined | string, undefined | string)
NewRetryPolicyFactory(IRetryOptions)

A RetryPolicy-gyár létrehozásához használt gyári metódus.

blobToArrayBuffer(Blob)

Browser Blob-objektum átalakítása ArrayBuffer-objektummá.

appendToURLPath(string, string)

Sztring hozzáfűzése az URL-elérési úthoz. Eltávolítja a duplikált "/" karaktert a sztring előtt, ha az URL-elérési út "/" végződéssel végződik.

base64decode(string)

Base64-dekódolás.

base64encode(string)

Base64-kód.

delay(number, AbortSignalLike, Error)

A megadott időintervallum késleltetése.

escapeURLPath(string)

A fenntartott URL-karaktereket megfelelően kell feloldani a Storage-szolgáltatásokhoz, például a Blobhoz vagy a Fájlhoz.

URL-kódolási és menekülési stratégia JSv10 SDK-khoz

Ha az ügyfelek URL-sztringet adnak át a XXXURL-osztályok konstruktorának, előfordulhat, hogy az URL-sztring már kódolt VAGY sem. Az Azure Storage-kiszolgálóra való küldés előtt azonban az URL-címet kódolni kell. Az SDK-k azonban nehezen találják ki, hogy az URL-sztring kódolása megtörtént-e. Két lehetséges stratégiánk van, és a XXXURL konstruktorok második stratégiáját választottuk.

Első stratégia: Tegyük fel, hogy az ügyfél URL-sztringje nincs kódolva, és mindig az SDK-ban kódolja az URL-sztringet.

A régi V2 SDK ezt teszi, egyszerű, és a legtöbb esetben működik.

  • Ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/b:", az SDK a következőre kódolja: "http://account.blob.core.windows.net/con/b%3A" és küldje el a kiszolgálóra. Létrejön egy "b:" nevű blob.
  • Ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/b%3A", az SDK a következőre kódolja: "http://account.blob.core.windows.net/con/b%253A" és küldje el a kiszolgálóra. Létrejön egy "b%3A" nevű blob.

Ez a stratégia azonban nem teszi lehetővé olyan blob létrehozását, amelynek nevében "?" szerepel. Mivel ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/blob?name", akkor a rendszer a blobnév helyett URL-paraméterként kezeli a "?nevet". Ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/blob%3Fname", létrejön egy "blob%3Fname" nevű blob. A V2 SDK nem rendelkezik ezzel a problémával, mert nem engedélyezi az ügyfél teljes URL-címének megadását, hanem egy külön blobnevet fogad el, és kódolja azURIComponent nevet. Nem fogadhatjuk el, hogy egy SDK nem tud blobnevet létrehozni a következővel: "?". Ezért implementáljuk a második stratégiát:

Második stratégia: Az SDK nem feltételezi, hogy az URL-cím kódolása megtörtént. Ez csak menekülni a különleges karaktereket.

Ezt teszi a V10 Blob Go SDK. Elfogad egy URL-típust a Go-ban, és meghívja az URL-címet. EscapePath(), hogy elkerülje a speciális chars unescaped.

  • Ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/b:", az SDK meg fog szabadulni a "http://account.blob.core.windows.net/con/b%3A" és küldje el a kiszolgálóra. Létrejön egy "b:" nevű blob.
  • Ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/b%3A", nincsenek speciális karakterek, ezért küldje el a "http://account.blob.core.windows.net/con/b%3A" kiszolgálóra. Létrejön egy "b:" nevű blob.
  • Ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/b%253A", nincsenek speciális karakterek, ezért küldje el a "http://account.blob.core.windows.net/con/b%253A" kiszolgálóra. Létrejön egy "b%3A" nevű blob.

Ezzel a stratégiával rugalmasan hozhatunk létre bármilyen speciális karaktert. A "%" azonban speciális karakterként lesz kezelve, ha az URL-sztring nincs kódolva, akkor az URL-sztringben nem szerepelhet "%", ellenkező esetben az URL-cím nem érvényes URL-cím. Ha az ügyfélnek létre kell hoznia egy "%" nevű blobot a blob nevében, használja a "%25" "insead of "%" parancsot. Csakúgy, mint a fenti 3. minta. A következő URL-sztringek pedig érvénytelenek:

  • "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"

Egy másik speciális karakter a "?", használja a "%2F" karaktert egy blobnév "?" karakterrel való ábrázolásához egy URL-sztringben.

A containerName, a blobName vagy más meghatározott XXXName paraméterek stratégiája olyan metódusokban, mint a BlobURL.fromContainerURL(containerURL, blobName)

Az első stratégiát alkalmazzuk, és meghívjuk a encodeURIComponent metódust ezekhez a paraméterekhez, például a blobName-hoz. Mivel az ügyfelek az URL-cím helyett egyszerű nevet adnak át.

getURLParameter(string, string)

URL-paraméter lekérése név alapján.

getURLPath(string)

URL-elérési út lekérése URL-sztringből.

getURLQueries(string)

URL-lekérdezéskulcs-értékpárok lekérése URL-sztringből.

padStart(string, number, undefined | string)

String.prototype.padStart()

setURLHost(string, string)

Állítsa be az URL-gazdagépet.

setURLParameter(string, string, undefined | string)

Adja meg az URL-paraméter nevét és értékét. Ha a név szerepel az URL-paraméterekben, a régi értéket névkulcs váltja fel. Ha nem ad meg értéket, a paraméter törlődik.

truncatedISO8061Date(Date, undefined | false | true)

Egy dátumot másodpercre kerekített.

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

Olvasható streamet olvas be pufferbe. Töltse ki a puffert az eltolástól a végéig.

Függvény adatai

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Létrehoz egy <xref:SASQueryParameters> objektumot, amely tartalmazza a tényleges REST-kérés létrehozásához szükséges összes SAS-lekérdezési paramétert.

function generateAccountSASQueryParameters(accountSASSignatureValues: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Paraméterek

accountSASSignatureValues
IAccountSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Válaszok

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Létrehoz egy SASQueryParameters-példányt.

Csak az SAS létrehozásához szükséges beállításokat fogadja el. Az opcionális beállításokhoz adja meg közvetlenül a megfelelő tulajdonságokat, például az engedélyeket, a startTime-t és az azonosítót.

FIGYELMEZTETÉS: Ha nincs megadva azonosító, engedélyekre és lejárati időre van szükség. A konstruktor első használatakor manuálisan kell értéket hozzárendelnie az azonosítóhoz vagy a expiryTime & engedélyekhez.

function generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Paraméterek

fileSASSignatureValues
IFileSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Válaszok

ipRangeToString(IIPRange)

IPRange formátumú sztring létrehozása. Például: "8.8.8.8" vagy "1.1.1.1-255.255.255.255"

function ipRangeToString(ipRange: IIPRange)

Paraméterek

ipRange
IIPRange

Válaszok

string

rangeToString(IRange)

Tartománysztring létrehozása. Például: "bytes=255-" vagy "bytes=0-511"

function rangeToString(iRange: IRange)

Paraméterek

iRange
IRange

Válaszok

string

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

CSAK BÖNGÉSZŐKBEN ÉRHETŐ EL. Feltölt egy böngésző Blob/File/ArrayBuffer/ArrayBufferView objektumot egy Azure-fájlba.

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

Paraméterek

aborter
Aborter

Hozzon létre egy új Aborter-példányt az Aborter.none vagy az Aborter.timeout(), az Aborter goto-dokumentumaival a kérelmek törlésére vonatkozó további példákért

browserData

Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer vagy ArrayBufferView

fileURL
FileURL

Válaszok

Promise<void>

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

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Egy Azure-fájlt a pufferrel párhuzamosan tölt le. Az eltolás és a darabszám megadása nem kötelező, a teljes fájl letöltéséhez adja meg a 0-t.

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

Paraméterek

aborter
Aborter

Hozzon létre egy új Aborter-példányt az Aborter.none vagy az Aborter.timeout(), az Aborter goto-dokumentumaival a kérelmek törlésére vonatkozó további példákért

buffer

Buffer

A kitöltéshez szükséges puffernek a darabszámnál nagyobb hosszúságúnak kell lennie

fileURL
FileURL

FileURL-objektum

offset

number

Az Azure-fájl letöltésének helye

count

undefined | number

Válaszok

Promise<void>

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Feltölt egy helyi fájlt egy Azure-fájlba.

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

Paraméterek

aborter
Aborter

Hozzon létre egy új Aborter-példányt az Aborter.none vagy az Aborter.timeout(), az Aborter goto-dokumentumaival a kérelmek törlésére vonatkozó további példákért

filePath

string

A helyi fájl teljes elérési útja

fileURL
FileURL

FileURL

Válaszok

Promise<void>

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

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Egy Node.js olvasható streamet tölt fel egy Azure-fájlba. Ez a módszer megpróbál létrehozni egy Azure-t, majd megkezdi a darabkák adattömb szerinti feltöltését. Az adattömb méretét bufferSize paraméter határozza meg. Győződjön meg arról, hogy a stream lehetséges mérete nem haladja meg a fájlméretet.

TELJESÍTMÉNYJAVÍTÁSI TIPPEK:

  • A bemeneti stream highWaterMark tulajdonsága jobb, ha ugyanazt az értéket a bufferSize paraméterrel állítja be, így elkerülhetők a Puffer.concat() műveletek.
function uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions)

Paraméterek

aborter
Aborter

Hozzon létre egy új Aborter-példányt az Aborter.none vagy az Aborter.timeout(), az Aborter goto-dokumentumaival a kérelmek törlésére vonatkozó további példákért

stream

Readable

Node.js olvasható streamet. A fájlméretnek kisebbnek vagy egyenlőnek kell lennie.

size

number

A létrehozandó fájl mérete. A megengedett maximális méret 1 TB. Ha ez az érték nagyobb, mint a stream mérete, üres bájtok lesznek a fájlszélben.

fileURL
FileURL

FileURL-példány

bufferSize

number

A bájtokban lefoglalt összes puffer mérete, valamint a feltöltött fájl adattömb/tartománymérete is. A méretnek 0 > és <= 4 * 1024 * 1024 (4 MB)

maxBuffers

number

A maximális pufferek a feltöltés során lesznek lefoglalva, pozitív korreláció a maximális feltöltési egyidejűséggel

Válaszok

Promise<void>

fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)

function fileAttributesToString(fileAttributes: FileSystemAttributes | FileAttributesPreserveType)

Paraméterek

Válaszok

string

fileCreationTimeToString(Date | TimeNowType | TimePreserveType)

function fileCreationTimeToString(time: Date | TimeNowType | TimePreserveType)

Paraméterek

Válaszok

string

fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)

function fileLastWriteTimeToString(time: Date | TimeNowType | TimePreserveType)

Paraméterek

Válaszok

string

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)

function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: IFileAndDirectoryCreateCommonOptions)

Paraméterek

Válaszok

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)

function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: IFileAndDirectorySetPropertiesCommonOptions)

Paraméterek

Válaszok

validateFilePermissionOptions(undefined | string, undefined | string)

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

Paraméterek

filePermission

undefined | string

filePermissionKey

undefined | string

NewRetryPolicyFactory(IRetryOptions)

A RetryPolicy-gyár létrehozásához használt gyári metódus.

function NewRetryPolicyFactory(retryOptions?: IRetryOptions)

Paraméterek

retryOptions
IRetryOptions

Válaszok

RequestPolicyFactory

blobToArrayBuffer(Blob)

Browser Blob-objektum átalakítása ArrayBuffer-objektummá.

function blobToArrayBuffer(blob: Blob)

Paraméterek

blob

Blob

Válaszok

Promise<ArrayBuffer>

appendToURLPath(string, string)

Sztring hozzáfűzése az URL-elérési úthoz. Eltávolítja a duplikált "/" karaktert a sztring előtt, ha az URL-elérési út "/" végződéssel végződik.

function appendToURLPath(url: string, name: string)

Paraméterek

url

string

Forrás URL-sztringje

name

string

Az URL-címhez hozzáfűzendő sztring

Válaszok

string

Frissített URL-sztring

base64decode(string)

Base64-dekódolás.

function base64decode(encodedString: string)

Paraméterek

encodedString

string

Válaszok

string

base64encode(string)

Base64-kód.

function base64encode(content: string)

Paraméterek

content

string

Válaszok

string

delay(number, AbortSignalLike, Error)

A megadott időintervallum késleltetése.

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

Paraméterek

timeInMs

number

aborter

AbortSignalLike

abortError

Error

Válaszok

Promise<unknown>

escapeURLPath(string)

A fenntartott URL-karaktereket megfelelően kell feloldani a Storage-szolgáltatásokhoz, például a Blobhoz vagy a Fájlhoz.

URL-kódolási és menekülési stratégia JSv10 SDK-khoz

Ha az ügyfelek URL-sztringet adnak át a XXXURL-osztályok konstruktorának, előfordulhat, hogy az URL-sztring már kódolt VAGY sem. Az Azure Storage-kiszolgálóra való küldés előtt azonban az URL-címet kódolni kell. Az SDK-k azonban nehezen találják ki, hogy az URL-sztring kódolása megtörtént-e. Két lehetséges stratégiánk van, és a XXXURL konstruktorok második stratégiáját választottuk.

Első stratégia: Tegyük fel, hogy az ügyfél URL-sztringje nincs kódolva, és mindig az SDK-ban kódolja az URL-sztringet.

A régi V2 SDK ezt teszi, egyszerű, és a legtöbb esetben működik.

  • Ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/b:", az SDK a következőre kódolja: "http://account.blob.core.windows.net/con/b%3A" és küldje el a kiszolgálóra. Létrejön egy "b:" nevű blob.
  • Ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/b%3A", az SDK a következőre kódolja: "http://account.blob.core.windows.net/con/b%253A" és küldje el a kiszolgálóra. Létrejön egy "b%3A" nevű blob.

Ez a stratégia azonban nem teszi lehetővé olyan blob létrehozását, amelynek nevében "?" szerepel. Mivel ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/blob?name", akkor a rendszer a blobnév helyett URL-paraméterként kezeli a "?nevet". Ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/blob%3Fname", létrejön egy "blob%3Fname" nevű blob. A V2 SDK nem rendelkezik ezzel a problémával, mert nem engedélyezi az ügyfél teljes URL-címének megadását, hanem egy külön blobnevet fogad el, és kódolja azURIComponent nevet. Nem fogadhatjuk el, hogy egy SDK nem tud blobnevet létrehozni a következővel: "?". Ezért implementáljuk a második stratégiát:

Második stratégia: Az SDK nem feltételezi, hogy az URL-cím kódolása megtörtént. Ez csak menekülni a különleges karaktereket.

Ezt teszi a V10 Blob Go SDK. Elfogad egy URL-típust a Go-ban, és meghívja az URL-címet. EscapePath(), hogy elkerülje a speciális chars unescaped.

  • Ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/b:", az SDK meg fog szabadulni a "http://account.blob.core.windows.net/con/b%3A" és küldje el a kiszolgálóra. Létrejön egy "b:" nevű blob.
  • Ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/b%3A", nincsenek speciális karakterek, ezért küldje el a "http://account.blob.core.windows.net/con/b%3A" kiszolgálóra. Létrejön egy "b:" nevű blob.
  • Ha az ügyfél URL-sztringje "http://account.blob.core.windows.net/con/b%253A", nincsenek speciális karakterek, ezért küldje el a "http://account.blob.core.windows.net/con/b%253A" kiszolgálóra. Létrejön egy "b%3A" nevű blob.

Ezzel a stratégiával rugalmasan hozhatunk létre bármilyen speciális karaktert. A "%" azonban speciális karakterként lesz kezelve, ha az URL-sztring nincs kódolva, akkor az URL-sztringben nem szerepelhet "%", ellenkező esetben az URL-cím nem érvényes URL-cím. Ha az ügyfélnek létre kell hoznia egy "%" nevű blobot a blob nevében, használja a "%25" "insead of "%" parancsot. Csakúgy, mint a fenti 3. minta. A következő URL-sztringek pedig érvénytelenek:

  • "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"

Egy másik speciális karakter a "?", használja a "%2F" karaktert egy blobnév "?" karakterrel való ábrázolásához egy URL-sztringben.

A containerName, a blobName vagy más meghatározott XXXName paraméterek stratégiája olyan metódusokban, mint a BlobURL.fromContainerURL(containerURL, blobName)

Az első stratégiát alkalmazzuk, és meghívjuk a encodeURIComponent metódust ezekhez a paraméterekhez, például a blobName-hoz. Mivel az ügyfelek az URL-cím helyett egyszerű nevet adnak át.

function escapeURLPath(url: string)

Paraméterek

url

string

Válaszok

string

getURLParameter(string, string)

URL-paraméter lekérése név alapján.

function getURLParameter(url: string, name: string)

Paraméterek

url

string

name

string

Válaszok

string | string[] | undefined

getURLPath(string)

URL-elérési út lekérése URL-sztringből.

function getURLPath(url: string)

Paraméterek

url

string

Forrás URL-sztringje

Válaszok

string | undefined

getURLQueries(string)

URL-lekérdezéskulcs-értékpárok lekérése URL-sztringből.

function getURLQueries(url: string)

Paraméterek

url

string

Válaszok

[key: string]: string

padStart(string, number, undefined | string)

String.prototype.padStart()

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

Paraméterek

currentString

string

targetLength

number

padString

undefined | string

Válaszok

string

setURLHost(string, string)

Állítsa be az URL-gazdagépet.

function setURLHost(url: string, host: string)

Paraméterek

url

string

Forrás URL-sztringje

host

string

Új gazdagép sztringje

Válaszok

string

Frissített URL-sztring

setURLParameter(string, string, undefined | string)

Adja meg az URL-paraméter nevét és értékét. Ha a név szerepel az URL-paraméterekben, a régi értéket névkulcs váltja fel. Ha nem ad meg értéket, a paraméter törlődik.

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

Paraméterek

url

string

Forrás URL-sztringje

name

string

Paraméter neve

value

undefined | string

Válaszok

string

Frissített URL-sztring

truncatedISO8061Date(Date, undefined | false | true)

Egy dátumot másodpercre kerekített.

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

Paraméterek

date

Date

withMilliseconds

undefined | false | true

Válaszok

string

Dátumsztring ISO8061 formátumban, 7 ezredmásodperc összetevővel vagy anélkül

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

Olvasható streamet olvas be pufferbe. Töltse ki a puffert az eltolástól a végéig.

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

Paraméterek

stream

ReadableStream

Egy Node.js olvasható stream

buffer

Buffer

Kitöltendő puffer, a hossznak >= eltolás

offset

number

A kitöltendő puffer helyzetének, beleértve a

end

number

A kitöltendő puffer pozíciója, kizárólagos

encoding

undefined | string

Válaszok

Promise<void>