ContainerListBlobsOptions interface

Paket:

@azure/storage-blob

Opsi untuk mengonfigurasi kontainer - Mencantumkan operasi Blob.

Lihat:

• ContainerClient.listBlobsFlat
• ContainerClient.listBlobsByHierarchy

Memperluas

CommonOptions

Properti

abortSignal	Implementasi antarmuka AbortSignalLike untuk memberi sinyal permintaan untuk membatalkan operasi. Misalnya, gunakan @azure/abort-controller untuk membuat AbortSignal.
endBefore	Optional. Menentukan jalur relatif dalam kontainer sebelum daftar berakhir. Hanya didukung jika format respons adalah StorageResponseFormat.Arrow.
includeCopy	Menentukan apakah metadata yang terkait dengan operasi Salin Blob saat ini atau sebelumnya harus disertakan dalam respons.
includeDeleted	Menentukan apakah blob yang dihapus sementara harus disertakan dalam respons.
includeDeletedWithVersions	Menentukan apakah blob yang dihapus dengan versi dikembalikan dalam respons.
includeImmutabilityPolicy	Menentukan apakah kebijakan kekekalan blob dikembalikan dalam respons.
includeLegalHold	Menentukan apakah penahanan legal blob dikembalikan dalam respons.
includeMetadata	Menentukan apakah metadata blob dikembalikan dalam respons.
includeSnapshots	Menentukan apakah rekam jepret harus disertakan dalam enumerasi. Rekam jepret tercantum dari yang terlama ke terbaru dalam respons.
includeTags	Menentukan apakah tag blob dikembalikan dalam respons.
includeUncommitedBlobs	Menentukan apakah blob yang bloknya telah diunggah, tetapi yang belum diterapkan menggunakan Put Block List, disertakan dalam respons.
includeVersions	Menentukan apakah versi harus disertakan dalam enumerasi. Versi dicantumkan dari yang terlama ke terbaru dalam respons.
prefix	Memfilter hasil untuk mengembalikan hanya kontainer yang namanya dimulai dengan awalan yang ditentukan.
responseFormat	Menentukan format yang harus digunakan layanan untuk mengembalikan hasil daftar. Default ke StorageResponseFormat.Auto.
startFrom	Menentukan jalur relatif untuk mencantumkan jalurnya. Untuk daftar non-rekursif, hanya satu tingkat entitas yang didukung; Untuk daftar rekursif, beberapa tingkat entitas didukung. (Termasuk)

Properti yang Diwariskan

tracingOptions

Opsi untuk mengonfigurasi rentang yang dibuat saat pelacakan diaktifkan.

Detail Properti

abortSignal

Implementasi antarmuka AbortSignalLike untuk memberi sinyal permintaan untuk membatalkan operasi. Misalnya, gunakan @azure/abort-controller untuk membuat AbortSignal.

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

endBefore

Optional. Menentukan jalur relatif dalam kontainer sebelum daftar berakhir. Hanya didukung jika format respons adalah StorageResponseFormat.Arrow.

endBefore?: string

Nilai Properti

string

includeCopy

Menentukan apakah metadata yang terkait dengan operasi Salin Blob saat ini atau sebelumnya harus disertakan dalam respons.

includeCopy?: boolean

Nilai Properti

boolean

includeDeleted

Menentukan apakah blob yang dihapus sementara harus disertakan dalam respons.

includeDeleted?: boolean

Nilai Properti

boolean

includeDeletedWithVersions

Menentukan apakah blob yang dihapus dengan versi dikembalikan dalam respons.

includeDeletedWithVersions?: boolean

Nilai Properti

boolean

includeImmutabilityPolicy

Menentukan apakah kebijakan kekekalan blob dikembalikan dalam respons.

includeImmutabilityPolicy?: boolean

Nilai Properti

boolean

includeLegalHold

Menentukan apakah penahanan legal blob dikembalikan dalam respons.

includeLegalHold?: boolean

Nilai Properti

boolean

includeMetadata

Menentukan apakah metadata blob dikembalikan dalam respons.

includeMetadata?: boolean

Nilai Properti

boolean

includeSnapshots

Menentukan apakah rekam jepret harus disertakan dalam enumerasi. Rekam jepret tercantum dari yang terlama ke terbaru dalam respons.

includeSnapshots?: boolean

Nilai Properti

boolean

includeTags

Menentukan apakah tag blob dikembalikan dalam respons.

includeTags?: boolean

Nilai Properti

boolean

includeUncommitedBlobs

Menentukan apakah blob yang bloknya telah diunggah, tetapi yang belum diterapkan menggunakan Put Block List, disertakan dalam respons.

includeUncommitedBlobs?: boolean

Nilai Properti

boolean

includeVersions

Menentukan apakah versi harus disertakan dalam enumerasi. Versi dicantumkan dari yang terlama ke terbaru dalam respons.

includeVersions?: boolean

Nilai Properti

boolean

prefix

Memfilter hasil untuk mengembalikan hanya kontainer yang namanya dimulai dengan awalan yang ditentukan.

prefix?: string

Nilai Properti

string

responseFormat

Menentukan format yang harus digunakan layanan untuk mengembalikan hasil daftar. Default ke StorageResponseFormat.Auto.

responseFormat?: StorageResponseFormat

Nilai Properti

StorageResponseFormat

startFrom

Menentukan jalur relatif untuk mencantumkan jalurnya. Untuk daftar non-rekursif, hanya satu tingkat entitas yang didukung; Untuk daftar rekursif, beberapa tingkat entitas didukung. (Termasuk)

startFrom?: string

Nilai Properti

string

Detail Properti yang Diwariskan

tracingOptions

Opsi untuk mengonfigurasi rentang yang dibuat saat pelacakan diaktifkan.

tracingOptions?: OperationTracingOptions

Nilai Properti

OperationTracingOptions

Diwarisi dariCommonOptions.tracingOptions