BlobBatch class
BlobBatch は、BLOB に対する操作の集計セットを表します。
現時点では、 と setAccessTier のみがdeleteサポートされています。
メソッド
| delete |
deleteBlob 操作は、指定された BLOB またはスナップショットに削除のマークを付けます。 BLOB は、後でガベージ コレクション中に削除されます。 バッチ要求ごとに許可される操作の種類は 1 つだけです。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 両方を同時に削除できます。 「削除操作の詳細」を参照してください。 操作は、指定された資格情報で認証および承認されます。 「BLOB バッチ承認の詳細」を参照してください。 |
| delete |
deleteBlob 操作は、指定された BLOB またはスナップショットに削除のマークを付けます。 BLOB は、後でガベージ コレクション中に削除されます。 バッチ要求ごとに許可される操作の種類は 1 つだけです。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 両方を同時に削除できます。 「削除操作の詳細」を参照してください。 操作は、指定された資格情報で認証および承認されます。 「BLOB バッチ承認の詳細」を参照してください。 |
| get |
サブ要求のアセンブリされた HTTP 要求本文を取得します。 |
| get |
バッチ要求の Content-Type の値を取得します。 値は、バッチ境界とマルチパート/混合である必要があります。 例: multipart/mixed;boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252 |
| get |
バッチ要求に追加されたサブ要求を取得します。 |
| set |
setBlobAccessTier 操作は、BLOB の層を設定します。 この操作は、BLOB ストレージまたは汎用 v2 アカウント内のブロック BLOB で許可されます。 バッチ要求ごとに許可される操作の種類は 1 つだけです。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 ブロック BLOB レベルの階層化の詳細については、「 ホット、クール、アーカイブのアクセス層」を参照してください。 操作は、指定された資格情報で認証され、承認されます。 BLOB バッチ承認の詳細を参照してください。 |
| set |
setBlobAccessTier 操作は、BLOB の層を設定します。 この操作は、BLOB ストレージまたは汎用 v2 アカウント内のブロック BLOB で許可されます。 バッチ要求ごとに許可される操作の種類は 1 つだけです。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 ブロック BLOB レベルの階層化の詳細については、「 ホット、クール、アーカイブのアクセス層」を参照してください。 操作は、指定された資格情報で認証され、承認されます。 BLOB バッチ承認の詳細を参照してください。 |
メソッドの詳細
deleteBlob(BlobClient, BlobDeleteOptions)
deleteBlob 操作は、指定された BLOB またはスナップショットに削除のマークを付けます。 BLOB は、後でガベージ コレクション中に削除されます。 バッチ要求ごとに許可される操作の種類は 1 つだけです。
BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 両方を同時に削除できます。 「削除操作の詳細」を参照してください。 操作は、指定された資格情報で認証および承認されます。 「BLOB バッチ承認の詳細」を参照してください。
function deleteBlob(blobClient: BlobClient, options?: BlobDeleteOptions): Promise<void>パラメーター
- blobClient
- BlobClient
BlobClient。
- options
- BlobDeleteOptions
戻り値
Promise<void>
deleteBlob(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)
deleteBlob 操作は、指定された BLOB またはスナップショットに削除のマークを付けます。 BLOB は、後でガベージ コレクション中に削除されます。 バッチ要求ごとに許可される操作の種類は 1 つだけです。
BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 両方を同時に削除できます。 「削除操作の詳細」を参照してください。 操作は、指定された資格情報で認証および承認されます。 「BLOB バッチ承認の詳細」を参照してください。
function deleteBlob(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobDeleteOptions): Promise<void>パラメーター
- url
-
string
削除する BLOB リソースの URL。
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
AnonymousCredential、StorageSharedKeyCredential、またはサービスに対する要求を @azure/identity 認証するためのパッケージからの任意の資格情報など。 TokenCredential インターフェイスを実装するオブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。
- options
- BlobDeleteOptions
戻り値
Promise<void>
getHttpRequestBody()
サブ要求のアセンブリされた HTTP 要求本文を取得します。
function getHttpRequestBody(): string戻り値
string
getMultiPartContentType()
バッチ要求の Content-Type の値を取得します。 値は、バッチ境界とマルチパート/混合である必要があります。 例: multipart/mixed;boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252
function getMultiPartContentType(): string戻り値
string
getSubRequests()
バッチ要求に追加されたサブ要求を取得します。
function getSubRequests(): Map<number, BatchSubRequest>戻り値
Map<number, BatchSubRequest>
setBlobAccessTier(BlobClient, AccessTier, BlobSetTierOptions)
setBlobAccessTier 操作は、BLOB の層を設定します。 この操作は、BLOB ストレージまたは汎用 v2 アカウント内のブロック BLOB で許可されます。 バッチ要求ごとに許可される操作の種類は 1 つだけです。
ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 ブロック BLOB レベルの階層化の詳細については、「 ホット、クール、アーカイブのアクセス層」を参照してください。 操作は、指定された資格情報で認証され、承認されます。 BLOB バッチ承認の詳細を参照してください。
function setBlobAccessTier(blobClient: BlobClient, tier: AccessTier, options?: BlobSetTierOptions): Promise<void>パラメーター
- blobClient
- BlobClient
BlobClient。
- tier
- AccessTier
- options
- BlobSetTierOptions
戻り値
Promise<void>
setBlobAccessTier(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)
setBlobAccessTier 操作は、BLOB の層を設定します。 この操作は、BLOB ストレージまたは汎用 v2 アカウント内のブロック BLOB で許可されます。 バッチ要求ごとに許可される操作の種類は 1 つだけです。
ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 ブロック BLOB レベルの階層化の詳細については、「 ホット、クール、アーカイブのアクセス層」を参照してください。 操作は、指定された資格情報で認証され、承認されます。 BLOB バッチ承認の詳細を参照してください。
function setBlobAccessTier(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, tier: AccessTier, options?: BlobSetTierOptions): Promise<void>パラメーター
- url
-
string
削除する BLOB リソースの URL。
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
AnonymousCredential、StorageSharedKeyCredential、またはサービスへの要求を @azure/identity 認証するためのパッケージからの資格情報など。 TokenCredential インターフェイスを実装する オブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。
- tier
- AccessTier
- options
- BlobSetTierOptions
戻り値
Promise<void>