@azure/storage-file package
クラス
| Aborter |
Aborter インスタンスは AbortSignal インターフェイスを実装し、HTTP 要求を中止できます。
既存のインスタンス アボートの場合:
|
| AccountSASPermissions |
NODE.JSランタイムでのみ使用できます。 これは、AccountSAS によって付与されるアクセス許可を表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS にその操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、<xref:IAccountSASSignatureValues> オブジェクトの権限フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。 |
| AccountSASResourceTypes |
NODE.JSランタイムでのみ使用できます。 これは、AccountSAS によってアクセス可能なリソースを表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、そのリソースの種類へのアクセスが許可されます。 すべての値が設定されたら、これを toString でシリアル化し、<xref:IAccountSASSignatureValues> オブジェクトのリソース フィールドとして設定する必要があります。 このクラスを使用せずにリソース文字列を構築することはできますが、リソースの順序は特定であり、このクラスは正確性を保証します。 |
| AccountSASServices |
NODE.JSランタイムでのみ使用できます。 これは、AccountSAS によってアクセス可能なサービスを表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、そのサービスへのアクセスが許可されます。 すべての値が設定されたら、これを toString でシリアル化し、<xref:IAccountSASSignatureValues> オブジェクトのサービス フィールドとして設定する必要があります。 このクラスを使用せずにサービス文字列を構築することはできますが、サービスの順序は特定であり、このクラスは正確性を保証します。 |
| BrowserPolicyFactory |
BrowserPolicyFactory は、BrowserPolicy オブジェクトの生成を支援するファクトリ クラスです。 |
| DirectoryURL |
DirectoryURL は、Azure Storage ディレクトリへの URL を表し、そのファイルとディレクトリを操作できます。 |
| FileSASPermissions |
NODE.JSランタイムでのみ使用できます。 これは、ServiceSAS によってファイルに付与されるアクセス許可を表す文字列を構築するヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS にその操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、<xref:IFileSASSignatureValues> オブジェクトの権限フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。 |
| FileSystemAttributes |
これは、ファイルまたはディレクトリへの NTFS 属性を表す文字列を構築するためのヘルパー クラスです。 |
| FileURL |
FileURL は、Azure Storage ファイルの URL を表します。 |
| KeepAlivePolicyFactory |
KeepAlivePolicyFactory は、KeepAlivePolicy オブジェクトの生成を支援するファクトリ クラスです。 |
| LoggingPolicyFactory |
LoggingPolicyFactory は、LoggingPolicy オブジェクトの生成を支援するファクトリ クラスです。 |
| Pipeline |
HTTP 要求ポリシーを含む Pipeline クラス。 StorageURL.newPipeline() を呼び出すことで、既定のパイプラインを作成できます。 または、Pipeline のコンストラクターによって独自のポリシーを使用してパイプラインを作成することもできます。 カスタマイズしたパイプラインを実装する前に、StorageURL.newPipeline() と指定されたポリシーを参照してください。 |
| RetryPolicyFactory |
RetryPolicyFactory は、RetryPolicy オブジェクトの生成を支援するファクトリ クラスです。 |
| SASQueryParameters |
Azure Storage SAS のクエリ パラメーターを構成するコンポーネントを表します。 この型は、ユーザーによって直接構築されるわけではありません。これは、<xref:IAccountSASSignatureValues> 型と <xref:IFileSASSignatureValues> 型によってのみ生成されます。 生成されたら、{@code String} にエンコードし、URL に直接追加できます (ただし、既存のクエリ パラメーターがある場合は注意が必要です。これらのクエリ パラメーターを追加する適切な方法に影響する可能性があります)。 注: このクラスのインスタンスは不変です。 |
| ServiceURL |
ServiceURL は、ファイル共有を操作できる Azure Storage File サービスへの URL を表します。 |
| ShareSASPermissions |
これは、ServiceSAS によって共有に付与されるアクセス許可を表す文字列を作成するヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS にその操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、<xref:IFileSASSignatureValues> オブジェクトの権限フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。 |
| ShareURL |
ShareURL は、Azure Storage 共有への URL を表し、そのディレクトリとファイルを操作できます。 |
| StorageURL |
ServiceURL は、ServiceURL、ContainerURL などのベースの URL クラスを表します。 |
| TelemetryPolicyFactory |
TelemetryPolicyFactory は、TelemetryPolicy オブジェクトの生成に役立つファクトリ クラスです。 |
| UniqueRequestIDPolicyFactory |
UniqueRequestIDPolicyFactory は、UniqueRequestIDPolicy オブジェクトの生成を支援するファクトリ クラスです。 |
| AnonymousCredential |
AnonymousCredential は、AnonymousCredentialPolicy オブジェクトの作成に使用される credentialPolicyCreator メンバーを提供します。 AnonymousCredentialPolicy は、パブリック リソースを読み取る HTTP(S) 要求または Shared Access Signature (SAS) で使用する要求で使用されます。 |
| Credential |
資格情報は、Azure Storage HTTP 要求の署名のための抽象クラスです。 このクラスは、CredentialPolicy を生成する credentialPolicyCreator ファクトリをホストします。 |
| SharedKeyCredential |
NODE.JSランタイムでのみ使用できます。 Azure Storage サービスのアカウント キー承認用の SharedKeyCredential。 |
| Directory |
ディレクトリを表すクラス。 |
| File |
ファイルを表すクラス。 |
| Service |
サービスを表すクラス。 |
| Share |
共有を表すクラス。 |
| StorageClient | |
| StorageClientContext | |
| AnonymousCredentialPolicy |
AnonymousCredentialPolicy は、パブリック リソースを読み取る HTTP(S) 要求または Shared Access Signature (SAS) で使用する要求で使用されます。 |
| BrowserPolicy |
BrowserPolicy は、次のような Node.js とブラウザー ランタイムの違いを処理します。
|
| CredentialPolicy |
送信前に HTTP(S) 要求に署名するために使用される資格情報ポリシー。 これは抽象クラスです。 |
| KeepAlivePolicy |
KeepAlivePolicy は、すべての要求のキープ アライブ設定を制御するために使用されるポリシーです。 |
| LoggingPolicy |
LoggingPolicy は、要求をログに記録するために使用されるポリシーです。 |
| RetryPolicy |
指数再試行と線形再試行が実装された再試行ポリシー。 |
| SharedKeyCredentialPolicy |
SharedKeyCredentialPolicy は、共有キーを使用して HTTP 要求に署名するために使用されるポリシーです。 |
| TelemetryPolicy |
TelemetryPolicy は、すべての要求に対してユーザー エージェント ヘッダーにタグを付けるために使用されるポリシーです。 |
| UniqueRequestIDPolicy |
UniqueRequestIDPolicy は、UUID を x-ms-request-id ヘッダー値として生成します。 |
| Batch |
Batch では、コンカレンシー制限を使用した基本的な並列実行が提供されます。 実行された操作の 1 つがエラーをスローすると、左の操作の実行を停止します。 ただし、Batch では進行中の操作を取り消すことはできません。取り消すには、自分で取り消す必要があります。 |
| BufferScheduler |
このクラスは、Node.js 読み取り可能ストリームを入力として受け取り、maxBuffers に到達するまでストリームから内部バッファー構造にデータを読み取り続けます。 使用可能なすべてのバッファーが outgoingHandler をトリガーしようとします。 内部バッファー構造には、受信バッファー配列と出力バッファー配列が含まれます。 受信バッファー配列には、新しい受信データを格納できる "空" バッファーが含まれています。 送信配列には、outgoingHandler によって処理される塗りつぶされたバッファーが含まれます。 上記のすべてのバッファー サイズは、パラメーター bufferSize によって定義されます。 NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING NUM_OF_ALL_BUFFERS <= 最大バッファ パフォーマンス向上のヒント:
|
| RetriableReadableStream |
NODE.JSランタイムでのみ使用できます。 Node.js ReadableStream は、内部 ReadableStream の予期しない終了時に内部的に再試行されます。 |
インターフェイス
型エイリアス
| FileDownloadResponse |
ダウンロード操作の応答データが含まれています。 |
| FileGetRangeListResponse |
getRangeList 操作の応答データを格納します。 |
| ShareGetAccessPolicyResponse |
getAccessPolicy 操作の応答データが含まれています。 |
| ShareGetStatisticsResponse |
getStatistics 操作の応答データを格納します。 |
| CredentialPolicyCreator |
指定された nextPolicy を使用する新しい CredentialPolicy を作成するファクトリ関数。 |
| CopyStatusType |
CopyStatusType の値を定義します。 使用可能な値は、'pending'、'success'、'aborted'、'failed' です。 |
| DeleteSnapshotsOptionType |
DeleteSnapshotsOptionType の値を定義します。 使用可能な値は次のとおりです: 'include' |
| DirectoryCreateResponse |
作成操作の応答データが含まれています。 |
| DirectoryDeleteResponse |
deleteMethod 操作の応答データを格納します。 |
| DirectoryForceCloseHandlesResponse |
forceCloseHandles 操作の応答データを格納します。 |
| DirectoryGetPropertiesResponse |
getProperties 操作の応答データを格納します。 |
| DirectoryListFilesAndDirectoriesSegmentResponse |
listFilesAndDirectoriesSegment 操作の応答データを格納します。 |
| DirectoryListHandlesResponse |
listHandles 操作の応答データを格納します。 |
| DirectorySetMetadataResponse |
setMetadata 操作の応答データが含まれています。 |
| DirectorySetPropertiesResponse |
setProperties 操作の応答データを格納します。 |
| FileAbortCopyResponse |
abortCopy 操作の応答データを格納します。 |
| FileCreateResponse |
作成操作の応答データが含まれています。 |
| FileDeleteResponse |
deleteMethod 操作の応答データを格納します。 |
| FileForceCloseHandlesResponse |
forceCloseHandles 操作の応答データを格納します。 |
| FileGetPropertiesResponse |
getProperties 操作の応答データを格納します。 |
| FileListHandlesResponse |
listHandles 操作の応答データを格納します。 |
| FileRangeWriteType |
FileRangeWriteType の値を定義します。 使用可能な値は、'update'、'clear' です。 |
| FileSetHTTPHeadersResponse |
setHTTPHeaders 操作の応答データが含まれています。 |
| FileSetMetadataResponse |
setMetadata 操作の応答データが含まれています。 |
| FileStartCopyResponse |
startCopy 操作の応答データを格納します。 |
| FileType |
FileType の値を定義します。 使用可能な値は次のとおりです: 'File' |
| FileUploadRangeFromURLResponse |
uploadRangeFromURL 操作の応答データが含まれています。 |
| FileUploadRangeResponse |
uploadRange 操作の応答データが含まれています。 |
| ListSharesIncludeType |
ListSharesIncludeType の値を定義します。 使用可能な値は、'snapshots'、'metadata' です。 |
| ServiceGetPropertiesResponse |
getProperties 操作の応答データを格納します。 |
| ServiceListSharesSegmentResponse |
listSharesSegment 操作の応答データを格納します。 |
| ServiceSetPropertiesResponse |
setProperties 操作の応答データを格納します。 |
| ShareCreatePermissionResponse |
createPermission 操作の応答データが含まれています。 |
| ShareCreateResponse |
作成操作の応答データが含まれています。 |
| ShareCreateSnapshotResponse |
createSnapshot 操作の応答データが含まれています。 |
| ShareDeleteResponse |
deleteMethod 操作の応答データを格納します。 |
| ShareGetPermissionResponse |
getPermission 操作の応答データが含まれています。 |
| ShareGetPropertiesResponse |
getProperties 操作の応答データを格納します。 |
| ShareSetAccessPolicyResponse |
setAccessPolicy 操作の応答データを格納します。 |
| ShareSetMetadataResponse |
setMetadata 操作の応答データが含まれています。 |
| ShareSetQuotaResponse |
setQuota 操作の応答データを格納します。 |
| StorageErrorCode |
StorageErrorCode の値を定義します。 使用できる値は、'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 |
既存のファイル属性を変更せずに保持します。 |
| FilePermissionInheritType |
親ディレクトリからのファイルの継承権限を示します。 |
| FilePermissionPreserveType |
既存のファイル権限の値を変更せずに保持します。 |
| TimeNowType |
要求の時刻として設定を示します。 |
| TimePreserveType |
既存の時刻値を変更せずに保持します。 |
| Operation |
操作は、Batch によって実行および管理される非同期関数です。 |
| OutgoingHandler |
OutgoingHandler は、BufferScheduler によってトリガーされる非同期関数です。 |
| ReadableStreamGetter | |
列挙型
| SASProtocol |
生成された SAS のプロトコル。 |
| RetryPolicyType |
RetryPolicy 型。 |
関数
| generate |
NODE.JSランタイムでのみ使用できます。 実際の REST 要求を行うために必要なすべての SAS クエリ パラメーターを含む <xref:SASQueryParameters> オブジェクトを生成します。 |
| generate |
NODE.JSランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。 SAS の作成に必要な設定のみを受け入れます。 オプションの設定については、アクセス許可、startTime、識別子など、対応するプロパティを直接設定してください。 警告: 識別子が指定されていない場合は、アクセス許可と expiryTime が必要です。 このコンストラクターを最初に使用する場合は、識別子または expiryTime & アクセス許可に値を手動で割り当てる必要があります。 |
| ip |
IPRange 書式指定文字列を生成します。 例: "8.8.8.8" または "1.1.1.1-255.255.255.255" |
| range |
範囲文字列を生成します。 例: "bytes=255-" または "bytes=0-511" |
| upload |
ブラウザーでのみ使用できます。 ブラウザー Blob/File/ArrayBuffer/ArrayBufferView オブジェクトを Azure File にアップロードします。 |
| download |
NODE.JSランタイムでのみ使用できます。 バッファーに並列で Azure ファイルをダウンロードします。 オフセットとカウントは省略可能で、両方に 0 を渡してファイル全体をダウンロードします。 |
| upload |
NODE.JSランタイムでのみ使用できます。 ローカル ファイルを Azure ファイルにアップロードします。 |
| upload |
NODE.JSランタイムでのみ使用できます。
Node.js 読み取り可能ストリームを Azure ファイルにアップロードします。
このメソッドは、Azure の作成を試み、チャンクごとにチャンクのアップロードを開始します。
チャンクのサイズは、 パフォーマンス向上のヒント:
|
| file |
|
| file |
|
| file |
|
| validate |
|
| validate |
|
| validate |
|
| New |
RetryPolicy ファクトリを生成するために使用されるファクトリ メソッド。 |
| blob |
ブラウザー BLOB オブジェクトを ArrayBuffer に変換します。 |
| append |
URL パスに文字列を追加します。 URL パスが "/" で終わると、文字列の前にある重複した "/" が削除されます。 |
| base64decode(string) | Base64 デコード。 |
| base64encode(string) | Base64 エンコード。 |
| delay(number, Abort |
指定された時間間隔を遅延します。 |
| escape |
BLOB や File などのストレージ サービスでは、予約済み URL 文字を適切にエスケープする必要があります。 JSv10 SDK の URL エンコードとエスケープ戦略お客様が URL 文字列を XXXURL クラス コンストラクターに渡す場合、URL 文字列は既に URL エンコードされているかどうかが考えられます。 ただし、Azure Storage サーバーに送信する前に、URL をエンコードする必要があります。 ただし、URL 文字列がエンコードされているかどうかを SDK が推測するのは困難です。 2 つの潜在的な戦略があり、XXXURL コンストラクターの戦略 2 を選択しました。 戦略 1: 顧客の URL 文字列がエンコードされておらず、常に SDK で URL 文字列をエンコードするとします。これは、従来の V2 SDK の機能であり、シンプルで、ほとんどの場合に機能します。
ただし、この方法では、名前に "?" を含む BLOB を作成することはできません。 顧客の URL 文字列が "http://account.blob.core.windows.net/con/blob?name"" の場合、"?name" は BLOB 名ではなく URL パラメーターとして扱われるためです。 顧客の URL 文字列が "http://account.blob.core.windows.net/con/blob%3Fname" の場合は、"blob%3Fname" という名前の BLOB が作成されます。 V2 SDK では、顧客が完全な URL を渡すことを許可せず、別の BLOB 名と encodeURIComponent を受け入れるため、この問題はありません。 SDK で "?"" の BLOB 名を作成することはできません。 そのため、戦略 2 を実装します。 戦略 2: SDK では、URL がエンコードされているかどうかを前提としません。 特殊文字をエスケープするだけです。V10 Blob Go SDK の機能は次のようになります。 Go で URL の種類を受け入れ、URL を呼び出します。エスケープされていない特殊な文字をエスケープする EscapedPath()
この戦略により、任意の特殊文字を使用して柔軟に作成できます。 ただし、"%" は特殊文字として扱われます。URL 文字列がエンコードされていない場合は、URL 文字列に "%" を指定しないでください。それ以外の場合、URL は有効な URL ではありません。 顧客が BLOB 名に "%" の BLOB を作成する必要がある場合は、"%25" insead of "%" を使用します。 上記の 3 番目のサンプルと同じです。 次の URL 文字列は無効です。
もう 1 つの特殊文字は"?"、"%2F" を使用して、URL 文字列に "?" を含む BLOB 名を表します。
|
| get |
名前で URL パラメーターを取得します。 |
| get |
URL 文字列から URL パスを取得します。 |
| get |
URL 文字列から URL クエリ キー値のペアを取得します。 |
| pad |
String.prototype.padStart() |
| set |
URL ホストを設定します。 |
| set |
URL パラメーターの名前と値を設定します。 URL パラメーターに名前が存在する場合、古い値は名前キーに置き換えられます。 値を指定しない場合、パラメーターは削除されます。 |
| truncatedISO8061Date(Date, undefined | false | true) | 日付を秒に丸めます。 |
| stream |
読み取り可能なストリームをバッファーに読み取ります。 バッファーをオフセットから末尾に塗りつぶします。 |
関数の詳細
generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)
NODE.JSランタイムでのみ使用できます。 実際の REST 要求を行うために必要なすべての SAS クエリ パラメーターを含む <xref:SASQueryParameters> オブジェクトを生成します。
function generateAccountSASQueryParameters(accountSASSignatureValues: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential)パラメーター
- accountSASSignatureValues
- IAccountSASSignatureValues
- sharedKeyCredential
- SharedKeyCredential
戻り値
generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)
NODE.JSランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。
SAS の作成に必要な設定のみを受け入れます。 オプションの設定については、アクセス許可、startTime、識別子など、対応するプロパティを直接設定してください。
警告: 識別子が指定されていない場合は、アクセス許可と expiryTime が必要です。 このコンストラクターを最初に使用する場合は、識別子または expiryTime & アクセス許可に値を手動で割り当てる必要があります。
function generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential)パラメーター
- fileSASSignatureValues
- IFileSASSignatureValues
- sharedKeyCredential
- SharedKeyCredential
戻り値
ipRangeToString(IIPRange)
IPRange 書式指定文字列を生成します。 例: "8.8.8.8" または "1.1.1.1-255.255.255.255"
function ipRangeToString(ipRange: IIPRange)パラメーター
- ipRange
- IIPRange
戻り値
string
rangeToString(IRange)
範囲文字列を生成します。 例: "bytes=255-" または "bytes=0-511"
function rangeToString(iRange: IRange)パラメーター
- iRange
- IRange
戻り値
string
uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)
ブラウザーでのみ使用できます。 ブラウザー Blob/File/ArrayBuffer/ArrayBufferView オブジェクトを Azure File にアップロードします。
function uploadBrowserDataToAzureFile(aborter: Aborter, browserData: Blob | ArrayBuffer | ArrayBufferView, fileURL: FileURL, options?: IUploadToAzureFileOptions)パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください
- browserData
-
Blob | ArrayBuffer | ArrayBufferView
Blob、File、ArrayBuffer、または ArrayBufferView
- fileURL
- FileURL
- options
- IUploadToAzureFileOptions
戻り値
Promise<void>
downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)
NODE.JSランタイムでのみ使用できます。 バッファーに並列で Azure ファイルをダウンロードします。 オフセットとカウントは省略可能で、両方に 0 を渡してファイル全体をダウンロードします。
function downloadAzureFileToBuffer(aborter: Aborter, buffer: Buffer, fileURL: FileURL, offset: number, count?: undefined | number, options?: IDownloadFromAzureFileOptions)パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください
- buffer
-
Buffer
バッファーがいっぱいになるには、count より長い長さが必要です
- fileURL
- FileURL
FileURL オブジェクト
- offset
-
number
ダウンロードする Azure ファイルの場所
- count
-
undefined | number
- options
- IDownloadFromAzureFileOptions
戻り値
Promise<void>
uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)
NODE.JSランタイムでのみ使用できます。 ローカル ファイルを Azure ファイルにアップロードします。
function uploadFileToAzureFile(aborter: Aborter, filePath: string, fileURL: FileURL, options?: IUploadToAzureFileOptions)パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください
- filePath
-
string
ローカル ファイルの完全パス
- fileURL
- FileURL
FileURL
- options
- IUploadToAzureFileOptions
戻り値
Promise<void>
uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)
NODE.JSランタイムでのみ使用できます。
Node.js 読み取り可能ストリームを Azure ファイルにアップロードします。
このメソッドは、Azure の作成を試み、チャンクごとにチャンクのアップロードを開始します。
チャンクのサイズは、bufferSize パラメーターによって定義されます。
ストリームの潜在的なサイズがファイル サイズを超えていないことを確認してください。
パフォーマンス向上のヒント:
- 入力ストリーム highWaterMark は、bufferSize パラメーターを使用して同じ値を設定することをお勧めします。これは、Buffer.concat() 操作を回避します。
function uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions)パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください
- stream
-
Readable
読み取り可能ストリームを Node.js します。 ファイル サイズ以下である必要があります。
- size
-
number
作成するファイルのサイズ。 最大サイズは 1 TB です。 この値がストリーム サイズより大きい場合は、ファイル末尾に空のバイトが存在します。
- fileURL
- FileURL
FileURL インスタンス
- bufferSize
-
number
バイト単位で割り当てられたすべてのバッファーのサイズ。また、アップロードされたファイル中のチャンク/範囲サイズ。 サイズは 0 >、<= 4 * 1024 * 1024 (4 MB) である必要があります
- maxBuffers
-
number
最大バッファーはアップロード中に割り当てられます。最大アップロードコンカレンシーとの正の相関関係
- options
- IUploadStreamToAzureFileOptions
戻り値
Promise<void>
fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)
function fileAttributesToString(fileAttributes: FileSystemAttributes | FileAttributesPreserveType)パラメーター
- fileAttributes
戻り値
string
fileCreationTimeToString(Date | TimeNowType | TimePreserveType)
function fileCreationTimeToString(time: Date | TimeNowType | TimePreserveType)パラメーター
- time
-
Date | TimeNowType | TimePreserveType
戻り値
string
fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)
function fileLastWriteTimeToString(time: Date | TimeNowType | TimePreserveType)パラメーター
- time
-
Date | TimeNowType | TimePreserveType
戻り値
string
validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)
function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: IFileAndDirectoryCreateCommonOptions)パラメーター
戻り値
validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)
function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: IFileAndDirectorySetPropertiesCommonOptions)パラメーター
戻り値
validateFilePermissionOptions(undefined | string, undefined | string)
function validateFilePermissionOptions(filePermission?: undefined | string, filePermissionKey?: undefined | string)パラメーター
- filePermission
-
undefined | string
- filePermissionKey
-
undefined | string
NewRetryPolicyFactory(IRetryOptions)
RetryPolicy ファクトリを生成するために使用されるファクトリ メソッド。
function NewRetryPolicyFactory(retryOptions?: IRetryOptions)パラメーター
- retryOptions
- IRetryOptions
戻り値
RequestPolicyFactory
blobToArrayBuffer(Blob)
ブラウザー BLOB オブジェクトを ArrayBuffer に変換します。
function blobToArrayBuffer(blob: Blob)パラメーター
- blob
-
Blob
戻り値
Promise<ArrayBuffer>
appendToURLPath(string, string)
URL パスに文字列を追加します。 URL パスが "/" で終わると、文字列の前にある重複した "/" が削除されます。
function appendToURLPath(url: string, name: string)パラメーター
- url
-
string
ソース URL 文字列
- name
-
string
URL に追加する文字列
戻り値
string
更新された URL 文字列
base64decode(string)
Base64 デコード。
function base64decode(encodedString: string)パラメーター
- encodedString
-
string
戻り値
string
base64encode(string)
Base64 エンコード。
function base64encode(content: string)パラメーター
- content
-
string
戻り値
string
delay(number, AbortSignalLike, Error)
指定された時間間隔を遅延します。
function delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error)パラメーター
- timeInMs
-
number
- aborter
-
AbortSignalLike
- abortError
-
Error
戻り値
Promise<unknown>
escapeURLPath(string)
BLOB や File などのストレージ サービスでは、予約済み URL 文字を適切にエスケープする必要があります。
JSv10 SDK の URL エンコードとエスケープ戦略
お客様が URL 文字列を XXXURL クラス コンストラクターに渡す場合、URL 文字列は既に URL エンコードされているかどうかが考えられます。 ただし、Azure Storage サーバーに送信する前に、URL をエンコードする必要があります。 ただし、URL 文字列がエンコードされているかどうかを SDK が推測するのは困難です。 2 つの潜在的な戦略があり、XXXURL コンストラクターの戦略 2 を選択しました。
戦略 1: 顧客の URL 文字列がエンコードされておらず、常に SDK で URL 文字列をエンコードするとします。
これは、従来の V2 SDK の機能であり、シンプルで、ほとんどの場合に機能します。
- 顧客の URL 文字列が "http://account.blob.core.windows.net/con/b:"" の場合、SDK はそれを "http://account.blob.core.windows.net/con/b%3A" にエンコードします。を選択し、サーバーに送信します。 "b:" という名前の BLOB が作成されます。
- 顧客の URL 文字列が "http://account.blob.core.windows.net/con/b%3A"" の場合、SDK はそれを "http://account.blob.core.windows.net/con/b%253A" にエンコードします。を選択し、サーバーに送信します。 "b%3A" という名前の BLOB が作成されます。
ただし、この方法では、名前に "?" を含む BLOB を作成することはできません。 顧客の URL 文字列が "http://account.blob.core.windows.net/con/blob?name"" の場合、"?name" は BLOB 名ではなく URL パラメーターとして扱われるためです。 顧客の URL 文字列が "http://account.blob.core.windows.net/con/blob%3Fname" の場合は、"blob%3Fname" という名前の BLOB が作成されます。 V2 SDK では、顧客が完全な URL を渡すことを許可せず、別の BLOB 名と encodeURIComponent を受け入れるため、この問題はありません。 SDK で "?"" の BLOB 名を作成することはできません。 そのため、戦略 2 を実装します。
戦略 2: SDK では、URL がエンコードされているかどうかを前提としません。 特殊文字をエスケープするだけです。
V10 Blob Go SDK の機能は次のようになります。 Go で URL の種類を受け入れ、URL を呼び出します。エスケープされていない特殊な文字をエスケープする EscapedPath()
- 顧客の URL 文字列が "http://account.blob.core.windows.net/con/b:"" の場合、SDK は ":" のように ":" をエスケープhttp://account.blob.core.windows.net/con/b%3A"。を選択し、サーバーに送信します。 "b:" という名前の BLOB が作成されます。
- 顧客の URL 文字列が "http://account.blob.core.windows.net/con/b%3A" の場合は、特殊文字がないため、"http://account.blob.core.windows.net/con/b%3A"" を送信します。をサーバーに送信します。 "b:" という名前の BLOB が作成されます。
- 顧客の URL 文字列が "http://account.blob.core.windows.net/con/b%253A" の場合は、特殊文字がないため、"http://account.blob.core.windows.net/con/b%253A"" を送信します。をサーバーに送信します。 "b%3A" という名前の BLOB が作成されます。
この戦略により、任意の特殊文字を使用して柔軟に作成できます。 ただし、"%" は特殊文字として扱われます。URL 文字列がエンコードされていない場合は、URL 文字列に "%" を指定しないでください。それ以外の場合、URL は有効な URL ではありません。 顧客が BLOB 名に "%" の BLOB を作成する必要がある場合は、"%25" insead of "%" を使用します。 上記の 3 番目のサンプルと同じです。 次の URL 文字列は無効です。
- 「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"
もう 1 つの特殊文字は"?"、"%2F" を使用して、URL 文字列に "?" を含む BLOB 名を表します。
BlobURL.fromContainerURL(containerURL, blobName) などのメソッド内の containerName、blobName、またはその他の特定の XXXName パラメーターの戦略
戦略 1 を適用し、blobName などのこれらのパラメーターに対して encodeURIComponent を呼び出します。 顧客が渡す名前は URL ではなくプレーンな名前であるためです。
function escapeURLPath(url: string)パラメーター
- url
-
string
戻り値
string
getURLParameter(string, string)
名前で URL パラメーターを取得します。
function getURLParameter(url: string, name: string)パラメーター
- url
-
string
- name
-
string
戻り値
string | string[] | undefined
getURLPath(string)
URL 文字列から URL パスを取得します。
function getURLPath(url: string)パラメーター
- url
-
string
ソース URL 文字列
戻り値
string | undefined
getURLQueries(string)
URL 文字列から URL クエリ キー値のペアを取得します。
function getURLQueries(url: string)パラメーター
- url
-
string
戻り値
[key: string]: string
padStart(string, number, undefined | string)
String.prototype.padStart()
function padStart(currentString: string, targetLength: number, padString?: undefined | string)パラメーター
- currentString
-
string
- targetLength
-
number
- padString
-
undefined | string
戻り値
string
setURLHost(string, string)
URL ホストを設定します。
function setURLHost(url: string, host: string)パラメーター
- url
-
string
ソース URL 文字列
- host
-
string
新しいホスト文字列
戻り値
string
更新された URL 文字列
setURLParameter(string, string, undefined | string)
URL パラメーターの名前と値を設定します。 URL パラメーターに名前が存在する場合、古い値は名前キーに置き換えられます。 値を指定しない場合、パラメーターは削除されます。
function setURLParameter(url: string, name: string, value?: undefined | string)パラメーター
- url
-
string
ソース URL 文字列
- name
-
string
パラメーター名
- value
-
undefined | string
戻り値
string
更新された URL 文字列
truncatedISO8061Date(Date, undefined | false | true)
日付を秒に丸めます。
function truncatedISO8061Date(date: Date, withMilliseconds?: undefined | false | true)パラメーター
- date
-
Date
- withMilliseconds
-
undefined | false | true
戻り値
string
7 ミリ秒のコンポーネントの有無にかかわらず、ISO8061形式の日付文字列
streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)
読み取り可能なストリームをバッファーに読み取ります。 バッファーをオフセットから末尾に塗りつぶします。
function streamToBuffer(stream: ReadableStream, buffer: Buffer, offset: number, end: number, encoding?: undefined | string)パラメーター
- stream
-
ReadableStream
Node.js 読み取り可能ストリーム
- buffer
-
Buffer
塗りつぶすバッファー、長さは >= オフセットにする必要があります
- offset
-
number
バッファー内のどの位置を埋めるか (両端を含む)
- end
-
number
バッファー内のどの位置にフィルするか(排他的)
- encoding
-
undefined | string
戻り値
Promise<void>
